com.norconex.importer.tagger.impl
Class ReplaceTagger

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

public class ReplaceTagger
extends Object
implements IDocumentTagger, IXMLConfigurable

Replaces an existing metadata value with another one. The "toName" argument is optional (the same field will be used for the replacement if no "toName" is specified").

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

XML configuration usage:

  <tagger class="com.norconex.importer.tagger.impl.ReplaceTagger">
      <replace fromName="sourceFieldName" toName="targetFieldName">
          <fromValue>Source Value</fromValue>
          <toValue>Target Value</toValue>
      </replace>
      <-- multiple replace tags allowed -->
  </tagger>
 

Author:
Pascal Essiembre
See Also:
Serialized Form

Nested Class Summary
 class ReplaceTagger.Replacement
           
 class ReplaceTagger.ReplacementDetails
           
 
Constructor Summary
ReplaceTagger()
           
 
Method Summary
 void addReplacement(String fromValue, String toValue, String fromName)
           
 void addReplacement(String fromValue, String toValue, String fromName, String toName)
           
 boolean equals(Object obj)
           
 Map<String,ReplaceTagger.Replacement> getReplacements()
           
 int hashCode()
           
 void loadFromXML(Reader in)
           
 void removeReplacement(String fromName)
           
 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

ReplaceTagger

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

getReplacements

public Map<String,ReplaceTagger.Replacement> getReplacements()

removeReplacement

public void removeReplacement(String fromName)

addReplacement

public void addReplacement(String fromValue,
                           String toValue,
                           String fromName)

addReplacement

public void addReplacement(String fromValue,
                           String toValue,
                           String fromName,
                           String toName)

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.