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
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:
<handler
class="com.norconex.importer.handler.transformer.impl.ReplaceTransformer"
maxReadSize="(max characters to read at once)"
sourceCharset="(character encoding)">
<!-- multiple "restrictTo" tags allowed (only one needs to match) -->
<restrictTo>
<fieldMatcher>(field-matching expression)</fieldMatcher>
<valueMatcher>(value-matching expression)</valueMatcher>
</restrictTo>
<!-- multiple replace tags allowed -->
<replace>
<valueMatcher>(one or more source values to replace)</valueMatcher>
<toValue>(replacement value)</toValue>
</replace>
</handler>
XML usage example:
<handler
class="ReplaceTransformer">
<replace>
<valueMatcher
replaceAll="true">
junk food
</valueMatcher>
<toValue>healthy food</toValue>
</replace>
</handler>
The above example reduces all occurrences of "junk food" with "healthy food".
- Since:
- 1.2.0
- Author:
- Pascal Essiembre
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddReplacement(ReplaceTransformer.Replacement replacement) booleaninthashCode()booleanDeprecated.Since 3.0.0.protected voidLoads configuration settings specific to the implementing class.protected voidSaves configuration settings specific to the implementing class.voidsetCaseSensitive(boolean caseSensitive) Deprecated.Since 3.0.0.voidsetReplacements(List<ReplaceTransformer.Replacement> replacements) toString()protected voidtransformStringContent(HandlerDoc doc, StringBuilder content, ParseState parseState, int sectionIndex) Methods inherited from class com.norconex.importer.handler.transformer.AbstractStringTransformer
getMaxReadSize, loadCharStreamTransformerFromXML, saveCharStreamTransformerToXML, setMaxReadSize, transformTextDocumentMethods inherited from class com.norconex.importer.handler.transformer.AbstractCharStreamTransformer
getSourceCharset, loadHandlerFromXML, saveHandlerToXML, setSourceCharset, transformApplicableDocumentMethods inherited from class com.norconex.importer.handler.transformer.AbstractDocumentTransformer
transformDocumentMethods inherited from class com.norconex.importer.handler.AbstractImporterHandler
addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXMLMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.norconex.commons.lang.xml.IXMLConfigurable
loadFromXML, saveToXML
-
Constructor Details
-
ReplaceTransformer
public ReplaceTransformer()
-
-
Method Details
-
transformStringContent
protected void transformStringContent(HandlerDoc doc, StringBuilder content, ParseState parseState, int sectionIndex) - Specified by:
transformStringContentin classAbstractStringTransformer
-
getReplacements
-
setReplacements
-
addReplacement
-
isCaseSensitive
Deprecated.Since 3.0.0.Deprecated. Always false.- Returns:
false
-
setCaseSensitive
Deprecated.Since 3.0.0.Deprecated. Has no effect.- Parameters:
caseSensitive-trueto consider character case
-
loadStringTransformerFromXML
Description copied from class:AbstractStringTransformerLoads configuration settings specific to the implementing class.- Specified by:
loadStringTransformerFromXMLin classAbstractStringTransformer- Parameters:
xml- XML configuration
-
saveStringTransformerToXML
Description copied from class:AbstractStringTransformerSaves 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:
saveStringTransformerToXMLin classAbstractStringTransformer- Parameters:
xml- the XML
-
equals
- Overrides:
equalsin classAbstractStringTransformer
-
hashCode
public int hashCode()- Overrides:
hashCodein classAbstractStringTransformer
-
toString
- Overrides:
toStringin classAbstractStringTransformer
-