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

Class CountMatchesTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.CountMatchesTransformer

All Implemented Interfaces:

Configurable<CountMatchesTransformerConfig>, ConfigurableDocHandler<CountMatchesTransformerConfig>, DocHandler

public class CountMatchesTransformer
extends Object
implements ConfigurableDocHandler<CountMatchesTransformerConfig>

Counts the number of matches of a given string (or string pattern) and store the resulting value in a field in the specified "toField".

If no "fieldMatcher" expression is specified, the document content will be used. If the "fieldMatcher" matches more than one field, the sum of all matches will be stored as a single value. More often than not, you probably want to set your "countMatcher" to "partial".

Storing values in an existing field

If a target field with the same name already exists for a document, the count value will be added to the end of the existing value list. It is possible to change this default behavior with CountMatchesTransformerConfig.setOnSet(PropertySetter).

Can be used as a pre-parse tagger on text document only when matching strings on document content, or both as a pre-parse or post-parse handler when the "fieldMatcher" is used.

See Also:

• Pattern
• CountMatchesTransformer 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
CountMatchesTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
CountMatchesTransformerConfig	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

CountMatchesTransformer

public CountMatchesTransformer()

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 CountMatchesTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<CountMatchesTransformerConfig>

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