Package com.norconex.importer.handler.transformer.impl

Class TextBetweenTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.TextBetweenTransformer

All Implemented Interfaces:

Configurable<TextBetweenTransformerConfig>, ConfigurableDocHandler<TextBetweenTransformerConfig>, DocHandler

public class TextBetweenTransformer
extends Object
implements ConfigurableDocHandler<TextBetweenTransformerConfig>

Extracts and add values found between a matching start and end strings to a document metadata field. The matching string end-points are defined in pairs and multiple ones can be specified at once. The field specified for a pair of end-points is considered a multi-value field.

If "fieldMatcher" is specified, it will use content from matching fields and storing all text extracted into the target field, multi-value. Else, the document content is used.

Storing values in an existing field

If a target field with the same name already exists for a document, values will be added to the end of the existing value list. It is possible to change this default behavior by supplying a PropertySetter.

This class can be used as a pre-parsing handler on text documents only or a post-parsing handler.

See Also:

• TextBetweenTransformer configuration reference

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Fields inherited from interface com.norconex.importer.handler.DocHandler

NAME

Constructor Summary

Constructors

Constructor	Description
TextBetweenTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
TextBetweenTransformerConfig	getConfiguration()
boolean	handle(DocHandlerContext docCtx)	Perform any operations on a document.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.norconex.importer.handler.DocHandler

close, init

Constructor Details

TextBetweenTransformer

public TextBetweenTransformer()

Method Details

handle

public boolean handle(DocHandlerContext docCtx)
               throws IOException

Description copied from interface: DocHandler

Perform any operations on a document.

Specified by:

handle in interface DocHandler

Parameters:

docCtx - the document handling context

Returns:

false to stop processing and reject a document or true to proceed to the next configured handler.

Throws:

IOException - An I/O exception of some sort has occurred

getConfiguration

public TextBetweenTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<TextBetweenTransformerConfig>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object