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.
<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
method="[basic|csv|wildcard|regex]"
ignoreCase="[false|true]"
ignoreDiacritic="[false|true]"
partial="[false|true]">
(field-matching expression)
</fieldMatcher>
<valueMatcher
method="[basic|csv|wildcard|regex]"
ignoreCase="[false|true]"
ignoreDiacritic="[false|true]"
partial="[false|true]">
(value-matching expression)
</valueMatcher>
</restrictTo>
<!-- multiple replace tags allowed -->
<replace>
<valueMatcher
method="[basic|csv|wildcard|regex]"
ignoreCase="[false|true]"
ignoreDiacritic="[false|true]"
replaceAll="[false|true]"
partial="[false|true]">
(one or more source values to replace)
</valueMatcher>
<toValue>(replacement value)</toValue>
</replace>
</handler>
<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".
Modifier and Type | Class and Description |
---|---|
static class |
ReplaceTransformer.Replacement |
Constructor and Description |
---|
ReplaceTransformer() |
Modifier and Type | Method and Description |
---|---|
void |
addReplacement(ReplaceTransformer.Replacement replacement) |
boolean |
equals(Object other) |
List<ReplaceTransformer.Replacement> |
getReplacements() |
int |
hashCode() |
boolean |
isCaseSensitive()
Deprecated.
Since 3.0.0.
|
protected void |
loadStringTransformerFromXML(XML xml)
Loads configuration settings specific to the implementing class.
|
protected void |
saveStringTransformerToXML(XML xml)
Saves configuration settings specific to the implementing class.
|
void |
setCaseSensitive(boolean caseSensitive)
Deprecated.
Since 3.0.0.
|
void |
setReplacements(List<ReplaceTransformer.Replacement> replacements) |
String |
toString() |
protected void |
transformStringContent(HandlerDoc doc,
StringBuilder content,
ParseState parseState,
int sectionIndex) |
getMaxReadSize, loadCharStreamTransformerFromXML, saveCharStreamTransformerToXML, setMaxReadSize, transformTextDocument
getSourceCharset, loadHandlerFromXML, saveHandlerToXML, setSourceCharset, transformApplicableDocument
transformDocument
addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
loadFromXML, saveToXML
protected void transformStringContent(HandlerDoc doc, StringBuilder content, ParseState parseState, int sectionIndex)
transformStringContent
in class AbstractStringTransformer
public List<ReplaceTransformer.Replacement> getReplacements()
public void setReplacements(List<ReplaceTransformer.Replacement> replacements)
public void addReplacement(ReplaceTransformer.Replacement replacement)
@Deprecated public boolean isCaseSensitive()
false
@Deprecated public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- true
to consider character caseprotected void loadStringTransformerFromXML(XML xml)
AbstractStringTransformer
loadStringTransformerFromXML
in class AbstractStringTransformer
xml
- XML configurationprotected void saveStringTransformerToXML(XML xml)
AbstractStringTransformer
saveStringTransformerToXML
in class AbstractStringTransformer
xml
- the XMLpublic boolean equals(Object other)
equals
in class AbstractStringTransformer
public int hashCode()
hashCode
in class AbstractStringTransformer
public String toString()
toString
in class AbstractStringTransformer
Copyright © 2009–2023 Norconex Inc.. All rights reserved.