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

Class CountMatchesTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.CountMatchesTransformerConfig

All Implemented Interfaces:

Labelable

public class CountMatchesTransformerConfig
extends BaseDocHandlerConfig

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

Constructor Summary

Constructors

Constructor	Description
CountMatchesTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
TextMatcher	getCountMatcher()	Gets the count matcher.
TextMatcher	getFieldMatcher()	Gets the field matcher.
int	getMaxReadSize()	The maximum number of characters to read from content for tagging at once.
PropertySetter	getOnSet()	Gets the property setter to use when a value is set.
Charset	getSourceCharset()
String	getToField()	The target field.
int	hashCode()
CountMatchesTransformerConfig	setCountMatcher(TextMatcher countMatcher)	Sets the count matcher.
CountMatchesTransformerConfig	setFieldMatcher(TextMatcher fieldMatcher)	Sets the field matcher.
CountMatchesTransformerConfig	setMaxReadSize(int maxReadSize)	The maximum number of characters to read from content for tagging at once.
CountMatchesTransformerConfig	setOnSet(PropertySetter onSet)	Gets the property setter to use when a value is set.
CountMatchesTransformerConfig	setSourceCharset(Charset sourceCharset)
CountMatchesTransformerConfig	setToField(String toField)	The target field.
String	toString()

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

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

Constructor Details

CountMatchesTransformerConfig

public CountMatchesTransformerConfig()

Method Details

getFieldMatcher

public TextMatcher getFieldMatcher()

Gets the field matcher.

Returns:

field matcher

setFieldMatcher

public CountMatchesTransformerConfig setFieldMatcher(TextMatcher fieldMatcher)

Sets the field matcher.

Parameters:

fieldMatcher - field matcher

getCountMatcher

public TextMatcher getCountMatcher()

Gets the count matcher.

Returns:

count matcher

setCountMatcher

public CountMatchesTransformerConfig setCountMatcher(TextMatcher countMatcher)

Sets the count matcher.

Parameters:

countMatcher - count matcher

getSourceCharset

public Charset getSourceCharset()

getToField

public String getToField()

The target field.

Returns:

target field

getOnSet

public PropertySetter getOnSet()

Gets the property setter to use when a value is set.

Returns:

property setter

getMaxReadSize

public int getMaxReadSize()

The maximum number of characters to read from content for tagging at once. Default is TextReader.DEFAULT_MAX_READ_SIZE.

Returns:

maximum read size

setSourceCharset

public CountMatchesTransformerConfig setSourceCharset(Charset sourceCharset)

Returns:

this.

setToField

public CountMatchesTransformerConfig setToField(String toField)

The target field.

Parameters:

toField - target field

Returns:

this.

setOnSet

public CountMatchesTransformerConfig setOnSet(PropertySetter onSet)

Gets the property setter to use when a value is set.

Parameters:

onSet - property setter

Returns:

this.

setMaxReadSize

public CountMatchesTransformerConfig setMaxReadSize(int maxReadSize)

The maximum number of characters to read from content for tagging at once. Default is TextReader.DEFAULT_MAX_READ_SIZE.

Parameters:

maxReadSize - maximum read size

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLabelableConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseLabelableConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLabelableConfig

toString

public String toString()

Overrides:

toString in class BaseLabelableConfig