com.norconex.importer.handler.transformer.impl

Class ReplaceTransformer

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.transformer.AbstractDocumentTransformer

com.norconex.importer.handler.transformer.AbstractCharStreamTransformer

com.norconex.importer.handler.transformer.AbstractStringTransformer

com.norconex.importer.handler.transformer.impl.ReplaceTransformer

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTransformer

public class ReplaceTransformer
extends AbstractStringTransformer
implements IXMLConfigurable

Replaces every occurrences of the given replacements (document content only).

This class can be used as a pre-parsing (text content-types only) or post-parsing handlers.

XML configuration usage:

  <transformer class="com.norconex.importer.handler.transformer.impl.ReplaceTransformer"
          caseSensitive="[false|true]"
          sourceCharset="(character encoding)"
          maxReadSize="(max characters to read at once)" >
      
      <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>
          <fromValue>(regex of value to replace)</fromValue>
          <toValue>(replacement value)</toValue>
      </replace>
      <!-- multiple replace tags allowed -->
      
  </transformer>
 

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

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

Usage example:

The following reduces all occurrences of "junk food" with "healthy food".

  <transformer class="com.norconex.importer.handler.transformer.impl.ReplaceTransformer">
      <replace>
          <fromValue>junk food</fromValue>
          <toValue>healthy food</toValue>
      </replace>
  </transformer>
 

Since:

1.2.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
ReplaceTransformer()

Method Summary

Modifier and Type	Method and Description
void	addReplacement(String from, String to)
boolean	equals(Object other)
Map<String,String>	getReplacements()
int	hashCode()
boolean	isCaseSensitive()
protected void	loadStringTransformerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveStringTransformerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setCaseSensitive(boolean caseSensitive) Sets whether to ignore case when matching characters or string to reduce.
String	toString()
protected void	transformStringContent(String reference, StringBuilder content, ImporterMetadata metadata, boolean parsed, int sectionIndex)

Methods inherited from class com.norconex.importer.handler.transformer.AbstractStringTransformer

getMaxReadSize, loadCharStreamTransformerFromXML, saveCharStreamTransformerToXML, setMaxReadSize, transformTextDocument

Methods inherited from class com.norconex.importer.handler.transformer.AbstractCharStreamTransformer

getSourceCharset, loadHandlerFromXML, saveHandlerToXML, setSourceCharset, transformApplicableDocument

Methods inherited from class com.norconex.importer.handler.transformer.AbstractDocumentTransformer

transformDocument

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

Methods inherited from interface com.norconex.commons.lang.config.IXMLConfigurable

loadFromXML, saveToXML

Constructor Detail

ReplaceTransformer

public ReplaceTransformer()

Method Detail

transformStringContent

protected void transformStringContent(String reference,
                                      StringBuilder content,
                                      ImporterMetadata metadata,
                                      boolean parsed,
                                      int sectionIndex)

Specified by:

transformStringContent in class AbstractStringTransformer

getReplacements

public Map<String,String> getReplacements()

addReplacement

public void addReplacement(String from,
                           String to)

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets whether to ignore case when matching characters or string to reduce.

Parameters:

caseSensitive - true to consider character case

loadStringTransformerFromXML

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

Description copied from class: AbstractStringTransformer

Loads configuration settings specific to the implementing class.

Specified by:

loadStringTransformerFromXML in class AbstractStringTransformer

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

saveStringTransformerToXML

protected void saveStringTransformerToXML(EnhancedXMLStreamWriter writer)
                                   throws XMLStreamException

Description copied from class: AbstractStringTransformer

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:

saveStringTransformerToXML in class AbstractStringTransformer

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStringTransformer

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractStringTransformer

toString

public String toString()

Overrides:

toString in class AbstractStringTransformer