com.norconex.importer.tagger.impl
Class KeepOnlyTagger

java.lang.Object
  extended by com.norconex.importer.tagger.impl.KeepOnlyTagger
All Implemented Interfaces:
IXMLConfigurable, IImportHandler, IDocumentTagger, Serializable

public class KeepOnlyTagger
extends Object
implements IDocumentTagger, IXMLConfigurable

Keep only the metadata fields provided, delete all other ones.

Can be used both as a pre-parse or post-parse handler.

XML configuration usage:

  <tagger class="com.norconex.importer.tagger.impl.KeepOnlyTagger"
      fields="[coma-separated list of fields to keep]"/>
 

Author:
Pascal Essiembre
See Also:
Serialized Form

Constructor Summary
KeepOnlyTagger()
           
 
Method Summary
 void addField(String field)
           
 boolean equals(Object obj)
           
 List<String> getFields()
           
 int hashCode()
           
 void loadFromXML(Reader in)
           
 void removeField(String field)
           
 void saveToXML(Writer out)
           
 void tagDocument(String reference, InputStream document, Properties metadata, boolean parsed)
          Tags a document with extra metadata information.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeepOnlyTagger

public KeepOnlyTagger()
Method Detail

tagDocument

public void tagDocument(String reference,
                        InputStream document,
                        Properties metadata,
                        boolean parsed)
                 throws IOException
Description copied from interface: IDocumentTagger
Tags a document with extra metadata information.

Specified by:
tagDocument in interface IDocumentTagger
Parameters:
reference - document reference (e.g. URL)
document - document
metadata - document metadata
parsed - whether the document has been parsed already or not (a parsed document should normally be text-based)
Throws:
IOException - problem reading the document

getFields

public List<String> getFields()

addField

public void addField(String field)

removeField

public void removeField(String field)

loadFromXML

public void loadFromXML(Reader in)
                 throws IOException
Specified by:
loadFromXML in interface IXMLConfigurable
Throws:
IOException

saveToXML

public void saveToXML(Writer out)
               throws IOException
Specified by:
saveToXML in interface IXMLConfigurable
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2009-2013 Norconex Inc.. All Rights Reserved.