com.exalead.indexing.analysis.v10

Class ReplaceValues

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.ReplaceValues

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ReplaceValues
extends SingleContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

The ReplaceValues processor compares all DocumentChunks for a given inputContext with the specified KeyValue map.
When the DocumentChunk value is an exact match, it is replaced by the specified string.
This processor can be used, for instance, to normalize different spelling for document metadata.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

SingleContextDocumentProcessor.Transformer<T>

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<KeyValue>	keyValue

Fields inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

inputContext

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
ReplaceValues()
ReplaceValues(ReplaceValues o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(SingleContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this ReplaceValues.
static ReplaceValues	fromString(java.lang.String s) String representation of this ReplaceValues.
java.util.List<KeyValue>	getKeyValue()
ReplaceValues	makeCopy() Creates and returns a deep copy of this ReplaceValues.
static ReplaceValues	readFrom(java.io.InputStream is) Read this ReplaceValues from an XML fragment.
java.lang.String	toString() String representation of this ReplaceValues.
ReplaceValues	withAcceptCondition(AcceptCondition acceptCondition)
ReplaceValues	withDataModelClass(java.lang.String dataModelClass)
ReplaceValues	withDataModelProperty(java.lang.String dataModelProperty)
ReplaceValues	withDataModelState(java.lang.String dataModelState)
ReplaceValues	withDisabled(boolean disabled)
ReplaceValues	withDisabled(java.lang.Boolean disabled)
ReplaceValues	withFromDataModel(DocumentProcessor fromDataModel)
ReplaceValues	withInputContext(java.lang.String inputContext)
ReplaceValues	withKeyValue(java.util.Collection<KeyValue> __values)
ReplaceValues	withKeyValue(KeyValue... __values)
ReplaceValues	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this ReplaceValues as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

getInputContext, setInputContext

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

Constructor Detail

ReplaceValues

public ReplaceValues()

ReplaceValues

public ReplaceValues(ReplaceValues o)

Copy constructor

Method Detail

withInputContext

public ReplaceValues withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public ReplaceValues withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public ReplaceValues withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public ReplaceValues withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public ReplaceValues withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public ReplaceValues withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public ReplaceValues withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public ReplaceValues withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public ReplaceValues withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public ReplaceValues withKeyValue(KeyValue... __values)

withKeyValue

public ReplaceValues withKeyValue(java.util.Collection<KeyValue> __values)

makeCopy

public ReplaceValues makeCopy()

Creates and returns a deep copy of this ReplaceValues.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

public static ReplaceValues readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this ReplaceValues from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ReplaceValues as an XML fragment

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ReplaceValues fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this ReplaceValues.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ReplaceValues.

Overrides:

toString in class SingleContextDocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ReplaceValues.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SingleContextDocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException