com.norconex.importer.handler.tagger.impl

Class ReplaceTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.ReplaceTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class ReplaceTagger
extends AbstractDocumentTagger

Replaces an existing metadata value with another one. The "toField" argument is optional. The same field will be used for the replacement if no "toField" is specified. If there are no matches and a "toField" is specified, no value will be added to the "toField". To have the original value copied in the "toField" when there are no matches, first copy the original value using CopyTagger to your target field then use this class on that new field without a "toField".

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

Since 2.6.1, you can specify whether matches should be made against the whole field value or not (default). You can also specify whether replacement should be attempted on first match only (default) or all occurrences. This last option is only applicable when whole value matching is false.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.ReplaceTagger">
  
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
      
      <replace fromField="sourceFieldName" toField="targetFieldName"
               caseSensitive="[false|true]"
               regex="[false|true]" 
               wholeMatch="[false|true]" 
               replaceAll="[false|true]">
          <fromValue>Source Value</fromValue>
          <toValue>Target Value</toValue>
      </replace>
      <!-- multiple replace tags allowed -->
      
  </tagger>
 

Note: To preserve white space add xml:space="preserve" to the "toValue" tag, like this:

   <toValue xml:space="preserve"> </toValue>
 

Usage example:

The following example replaces occurrences of "apple" to "orange" in the "fruit" field.

  <tagger class="com.norconex.importer.handler.tagger.impl.ReplaceTagger">
      <replace fromField="fruit" replaceAll="true">
          <fromValue>apple</fromValue>
          <toValue>orange</toValue>
      </replace>
  </tagger>
 

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplaceTagger.Replacement

Constructor Summary

Constructors

Constructor and Description
ReplaceTagger()

Method Summary

Modifier and Type	Method and Description
void	addReplacement(ReplaceTagger.Replacement replacement) Adds a replacement.
void	addReplacement(String fromValue, String toValue, String fromField) Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.
void	addReplacement(String fromValue, String toValue, String fromField, boolean regex) Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.
void	addReplacement(String fromValue, String toValue, String fromField, String toField) Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.
void	addReplacement(String fromValue, String toValue, String fromField, String toField, boolean regex) Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.
boolean	equals(Object other)
List<ReplaceTagger.Replacement>	getReplacements()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeReplacement(String fromField)
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	tagApplicableDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed)
String	toString()

Methods inherited from class com.norconex.importer.handler.tagger.AbstractDocumentTagger

tagDocument

Methods inherited from class com.norconex.importer.handler.AbstractImporterHandler

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplaceTagger

public ReplaceTagger()

Method Detail

tagApplicableDocument

public void tagApplicableDocument(String reference,
                                  InputStream document,
                                  ImporterMetadata metadata,
                                  boolean parsed)
                           throws ImporterHandlerException

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getReplacements

public List<ReplaceTagger.Replacement> getReplacements()

removeReplacement

public void removeReplacement(String fromField)

addReplacement

@Deprecated
public void addReplacement(String fromValue,
                                        String toValue,
                                        String fromField)

Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.

Adds a replacement.

Parameters:

fromValue - value to replace

toValue - replacement value

fromField - field holding the value to replace

addReplacement

@Deprecated
public void addReplacement(String fromValue,
                                        String toValue,
                                        String fromField,
                                        boolean regex)

Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.

Adds a replacement.

Parameters:

fromValue - value to replace

toValue - replacement value

fromField - field holding the value to replace

regex - true if a regular expression

addReplacement

@Deprecated
public void addReplacement(String fromValue,
                                        String toValue,
                                        String fromField,
                                        String toField)

Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.

Adds a replacement.

Parameters:

fromValue - value to replace

toValue - replacement value

fromField - field holding the value to replace

toField - field to store the replaced value

addReplacement

@Deprecated
public void addReplacement(String fromValue,
                                        String toValue,
                                        String fromField,
                                        String toField,
                                        boolean regex)

Deprecated. Since 2.2.0, use addReplacement(Replacement) instead.

Adds a replacement.

Parameters:

fromValue - value to replace

toValue - replacement value

fromField - field holding the value to replace

toField - field to store the replaced value

regex - true if a regular expression

addReplacement

public void addReplacement(ReplaceTagger.Replacement replacement)

Adds a replacement.

Parameters:

replacement - the replacement

Since:

2.2.0

loadHandlerFromXML

protected void loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                           throws IOException

Description copied from class: AbstractImporterHandler

Loads configuration settings specific to the implementing class.

Specified by:

loadHandlerFromXML in class AbstractImporterHandler

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

saveHandlerToXML

protected void saveHandlerToXML(EnhancedXMLStreamWriter writer)
                         throws XMLStreamException

Description copied from class: AbstractImporterHandler

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveHandlerToXML in class AbstractImporterHandler

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler