com.norconex.importer.handler.transformer.impl

Class SubstringTransformer

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.impl.SubstringTransformer

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTransformer

public class SubstringTransformer
extends AbstractCharStreamTransformer
implements IXMLConfigurable

Keep a substring of the content matching a begin and end character indexes. Useful when you have to truncate long content, or when you know precisely where is located the text to extract in some files.

The "begin" value is inclusive, while the "end" value is exclusive. Both are optional. When not specified (or a negative value), the index is assumed to be the beginning and end of the content, respectively.

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.SubstringTransformer"
          begin="(number)" end="(number)">
      
      <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) -->
      
  </transformer>
 

Usage example:

The following truncates long text to be 10,000 characters maximum.

  <transformer class="com.norconex.importer.handler.transformer.impl.SubstringTransformer"
          end="10000"/>
 

Since:

2.7.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
SubstringTransformer()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
long	getBegin()
long	getEnd()
int	hashCode()
protected void	loadCharStreamTransformerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveCharStreamTransformerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setBegin(long beginIndex) Sets the beginning index (inclusive).
void	setEnd(long endIndex) Sets the end index (exclusive).
String	toString()
protected void	transformTextDocument(String reference, Reader input, Writer output, ImporterMetadata metadata, boolean parsed)

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

SubstringTransformer

public SubstringTransformer()

Method Detail

getBegin

public long getBegin()

setBegin

public void setBegin(long beginIndex)

Sets the beginning index (inclusive). A negative value is treated the same as zero.

Parameters:

beginIndex - beginning index

getEnd

public long getEnd()

setEnd

public void setEnd(long endIndex)

Sets the end index (exclusive). A negative value is treated as the content end.

Parameters:

endIndex - end index

transformTextDocument

protected void transformTextDocument(String reference,
                                     Reader input,
                                     Writer output,
                                     ImporterMetadata metadata,
                                     boolean parsed)
                              throws ImporterHandlerException

Specified by:

transformTextDocument in class AbstractCharStreamTransformer

Throws:

ImporterHandlerException

saveCharStreamTransformerToXML

protected void saveCharStreamTransformerToXML(EnhancedXMLStreamWriter writer)
                                       throws XMLStreamException

Description copied from class: AbstractCharStreamTransformer

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:

saveCharStreamTransformerToXML in class AbstractCharStreamTransformer

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

loadCharStreamTransformerFromXML

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

Description copied from class: AbstractCharStreamTransformer

Loads configuration settings specific to the implementing class.

Specified by:

loadCharStreamTransformerFromXML in class AbstractCharStreamTransformer

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCharStreamTransformer

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractCharStreamTransformer

toString

public String toString()

Overrides:

toString in class AbstractCharStreamTransformer