com.norconex.importer.tagger.impl
Class ConstantTagger

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

public class ConstantTagger
extends Object
implements IDocumentTagger, IXMLConfigurable

Define and add constant values to documents. To add multiple constant values under the same constant name, repeat the constant entry with a different value.

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

XML configuration usage:

  <tagger class="com.norconex.importer.tagger.impl.ConstantTagger">
      <constant name="CONSTANT_NAME">Constant Value</constant>
      <-- multiple constant tags allowed -->
  </tagger>
 

Author:
Pascal Essiembre
See Also:
Serialized Form

Constructor Summary
ConstantTagger()
           
 
Method Summary
 void addConstant(String name, String value)
           
 boolean equals(Object obj)
           
 Map<String,List<String>> getConstants()
           
 int hashCode()
           
 void loadFromXML(Reader in)
           
 void removeConstant(String name)
           
 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

ConstantTagger

public ConstantTagger()
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

getConstants

public Map<String,List<String>> getConstants()

addConstant

public void addConstant(String name,
                        String value)

removeConstant

public void removeConstant(String name)

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.