Package de.cxp.ocs.preprocessor

Class ConfigureableDataprocessor<T extends ConfigureableField>

java.lang.Object

de.cxp.ocs.preprocessor.ConfigureableDataprocessor<T>

Type Parameters:

T - ConfigureableField implementation to which the DocumentPreProcessor gets mapped.

All Implemented Interfaces:

DocumentPreProcessor

Direct Known Subclasses:

RemoveValuesDataProcessor, ReplacePatternInValuesDataProcessor, SplitValueDataProcessor

public abstract class ConfigureableDataprocessor<T extends ConfigureableField>
extends Object
implements DocumentPreProcessor

Abstract class which handles reading and initializing DocumentPreProcessor implementations which need further configuration.

Author:

hjk

Field Summary

Fields

Modifier and Type	Field	Description
protected List<T>	patternConf
protected IndexConfiguration	properties

Constructor Summary

Constructors

Constructor	Description
ConfigureableDataprocessor()

Method Summary

Modifier and Type	Method	Description
protected abstract T	getPatternConfiguration(String key, String value, Map<String,String> confMap)	Returns the ConfigureableField holding the parsed configuration for every configured key.
protected abstract BiConsumer<T,Object>	getProcessConsumer(Document sourceDocument, boolean visible)	Returns a BiConsumer whose input is the configured ConfigureableField with the value of the currently processed record.
void	initialize(FieldConfigAccess fieldConfig, Map<String,String> confMap)	DataPreProcessor MUST have a no-args constructor.
protected boolean	isRecordVisible(Document sourceDocument, boolean visible)	Called at the end of each process(Document, boolean) run after getProcessConsumer(Document, boolean) is has run for every ConfigureableField, to determine weather the record should be visible or not.
boolean	process(Document sourceDocument, boolean visible)	Called for each source document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.cxp.ocs.spi.indexer.DocumentPreProcessor

finish

Field Details

properties

protected IndexConfiguration properties

patternConf

protected List<T extends ConfigureableField> patternConf

Constructor Details

ConfigureableDataprocessor

public ConfigureableDataprocessor()

Method Details

initialize

public void initialize(FieldConfigAccess fieldConfig,
 Map<String,String> confMap)

Description copied from interface: DocumentPreProcessor

DataPreProcessor MUST have a no-args constructor. To configure it afterwards, this method will be used.

Specified by:

initialize in interface DocumentPreProcessor

Parameters:

fieldConfig - field config access

confMap - custom string-to-string map that can be configured per DocumentPreProcessor.

getPatternConfiguration

protected abstract T getPatternConfiguration(String key,
 String value,
 Map<String,String> confMap)

Returns the ConfigureableField holding the parsed configuration for every configured key.

Parameters:

key - a key from the data processor configuration for this data processor.

value - the value of that key.

confMap - the complete data processor configuration map.

Returns:

the parsed configurable field for the key.

process

public boolean process(Document sourceDocument,
 boolean visible)

Description copied from interface: DocumentPreProcessor

Called for each source document.

Specified by:

process in interface DocumentPreProcessor

Parameters:

sourceDocument - source document

visible - weather or not the record is currently marked for indexing.

Returns:

true if the record should be indexed, false otherwise.

getProcessConsumer

protected abstract BiConsumer<T,Object> getProcessConsumer(Document sourceDocument,
 boolean visible)

Returns a BiConsumer whose input is the configured ConfigureableField with the value of the currently processed record. The consumer gets called in the DocumentPreProcessor.process(Document, boolean) method for each configured key.

Parameters:

sourceDocument - the record data

visible - the current visibility of the record

Returns:

a BiConsumer whose accept method should handle every PatternConfiguration with the corresponding value.

isRecordVisible

protected boolean isRecordVisible(Document sourceDocument,
 boolean visible)

Called at the end of each process(Document, boolean) run after getProcessConsumer(Document, boolean) is has run for every ConfigureableField, to determine weather the record should be visible or not.

Parameters:

sourceDocument - the record data

visible - the current visibility of the record

Returns:

true if the record should be indexed, false otherwise.