com.norconex.importer.handler.transformer.impl

Class StripBetweenTransformer

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.StripBetweenTransformer

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTransformer

public class StripBetweenTransformer
extends AbstractStringTransformer
implements IXMLConfigurable

Strips any content found between a matching start and end strings. The matching strings are defined in pairs and multiple ones can be specified at once.

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.StripBetweenTransformer"
          inclusive="[false|true]" 
          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) -->
      
      <stripBetween>
          <start>(regex)</start>
          <end>(regex)</end>
      </stripBetween>
      <!-- multiple stripBetween tags allowed -->
      
  </transformer>
 

Usage example:

The following will strip all text between (and including) these two HTML comments: <!-- SIDENAV_START --> and <!-- SIDENAV_END -->.

  <transformer class="com.norconex.importer.handler.transformer.impl.StripBetweenTransformer"
          inclusive="true" >
      <stripBetween>
          <start><![CDATA[<!-- SIDENAV_START -->]]></start>
          <end><![CDATA[<!-- SIDENAV_END -->]]></end>
      </stripBetween>
  </transformer>
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
StripBetweenTransformer()

Method Summary

Modifier and Type	Method and Description
void	addStripEndpoints(String fromText, String toText)
boolean	equals(Object other)
List<org.apache.commons.lang3.tuple.Pair<String,String>>	getStripEndpoints()
int	hashCode()
boolean	isCaseSensitive()
boolean	isInclusive()
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 start and end text.
void	setInclusive(boolean inclusive) Sets whether start and end text pairs should themselves be stripped or not.
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

StripBetweenTransformer

public StripBetweenTransformer()

Method Detail

transformStringContent

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

Specified by:

transformStringContent in class AbstractStringTransformer

isInclusive

public boolean isInclusive()

setInclusive

public void setInclusive(boolean inclusive)

Sets whether start and end text pairs should themselves be stripped or not.

Parameters:

inclusive - true to strip start and end text

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets whether to ignore case when matching start and end text.

Parameters:

caseSensitive - true to consider character case

addStripEndpoints

public void addStripEndpoints(String fromText,
                              String toText)

getStripEndpoints

public List<org.apache.commons.lang3.tuple.Pair<String,String>> getStripEndpoints()

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