com.exalead.indexing.analysis.v10

Class ConcatValues

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.ConcatValues

All Implemented Interfaces:

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

public class ConcatValues
extends MultiContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Concatenates all textual content of DocumentChunks where ContextName matches 'inputContexts', and joins them with the 'join' string.
A single DocumentChunk with ContextName 'outputContext' is created as an output.

See Also:

Serialized Form

Nested Class Summary

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

MultiContextDocumentProcessor.InputContexts, MultiContextDocumentProcessor.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
boolean	allowDuplicates
boolean	cartesianProduct
static boolean	DEFAULT_ALLOW_DUPLICATES
static boolean	DEFAULT_CARTESIAN_PRODUCT
static boolean	DEFAULT_STRICT
java.lang.String	join
java.lang.String	outputContext
boolean	strict

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

inputContexts

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
ConcatValues()
ConcatValues(ConcatValues o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(MultiContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this ConcatValues.
static ConcatValues	fromString(java.lang.String s) String representation of this ConcatValues.
java.lang.String	getJoin() Optional string inserted between concatenated values.
java.lang.String	getOutputContext() ContextName to be associated with the DocumentChunk created for each concatenated value.
boolean	isAllowDuplicates() If true, and if there are multiple DocumentChunks with the same ContextName, it concatenates them all. If false, only the first DocumentChunk among all those with the same ContextName is kept.
boolean	isCartesianProduct() If there are multiple DocumentChunks with the same ContextName, it generates the cartesian product between all values.
boolean	isStrict() Forces all the input contexts found to generate the concatenation.
ConcatValues	makeCopy() Creates and returns a deep copy of this ConcatValues.
static ConcatValues	readFrom(java.io.InputStream is) Read this ConcatValues from an XML fragment.
void	setAllowDuplicates(boolean allowDuplicates) If true, and if there are multiple DocumentChunks with the same ContextName, it concatenates them all. If false, only the first DocumentChunk among all those with the same ContextName is kept.
void	setCartesianProduct(boolean cartesianProduct) If there are multiple DocumentChunks with the same ContextName, it generates the cartesian product between all values.
void	setJoin(java.lang.String join) Optional string inserted between concatenated values.
void	setOutputContext(java.lang.String outputContext) ContextName to be associated with the DocumentChunk created for each concatenated value.
void	setStrict(boolean strict) Forces all the input contexts found to generate the concatenation.
java.lang.String	toString() String representation of this ConcatValues.
ConcatValues	withAcceptCondition(AcceptCondition acceptCondition)
ConcatValues	withAllowDuplicates(boolean allowDuplicates)
ConcatValues	withAllowDuplicates(java.lang.Boolean allowDuplicates)
ConcatValues	withCartesianProduct(boolean cartesianProduct)
ConcatValues	withCartesianProduct(java.lang.Boolean cartesianProduct)
ConcatValues	withDataModelClass(java.lang.String dataModelClass)
ConcatValues	withDataModelProperty(java.lang.String dataModelProperty)
ConcatValues	withDataModelState(java.lang.String dataModelState)
ConcatValues	withDisabled(boolean disabled)
ConcatValues	withDisabled(java.lang.Boolean disabled)
ConcatValues	withFromDataModel(DocumentProcessor fromDataModel)
ConcatValues	withInputContexts(java.util.Collection<StringValue> __values)
ConcatValues	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
ConcatValues	withJoin(java.lang.String join)
ConcatValues	withName(java.lang.String name)
ConcatValues	withOutputContext(java.lang.String outputContext)
ConcatValues	withStrict(boolean strict)
ConcatValues	withStrict(java.lang.Boolean strict)
void	writeTo(java.io.OutputStream os) Write this ConcatValues as an XML fragment

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

getInputContexts, setInputContexts, withInputContexts

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

outputContext

public java.lang.String outputContext

join

public java.lang.String join

strict

public boolean strict

DEFAULT_STRICT

public static final boolean DEFAULT_STRICT

See Also:

Constant Field Values

allowDuplicates

public boolean allowDuplicates

DEFAULT_ALLOW_DUPLICATES

public static final boolean DEFAULT_ALLOW_DUPLICATES

See Also:

Constant Field Values

cartesianProduct

public boolean cartesianProduct

DEFAULT_CARTESIAN_PRODUCT

public static final boolean DEFAULT_CARTESIAN_PRODUCT

See Also:

Constant Field Values

Constructor Detail

ConcatValues

public ConcatValues()

ConcatValues

public ConcatValues(ConcatValues o)

Copy constructor

Method Detail

withInputContexts

public ConcatValues withInputContexts(StringValue... __values)

The processor will only be applied to DocumentChunks with a ContextName specified in this list.

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withInputContexts

public ConcatValues withInputContexts(java.util.Collection<StringValue> __values)

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public ConcatValues withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public ConcatValues withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public ConcatValues withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public ConcatValues withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public ConcatValues withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public ConcatValues withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public ConcatValues withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public ConcatValues withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

ContextName to be associated with the DocumentChunk created for each concatenated value.

getOutputContext

public java.lang.String getOutputContext()

ContextName to be associated with the DocumentChunk created for each concatenated value.

withOutputContext

public ConcatValues withOutputContext(java.lang.String outputContext)

setJoin

public void setJoin(java.lang.String join)

Optional string inserted between concatenated values.

getJoin

public java.lang.String getJoin()

Optional string inserted between concatenated values.

withJoin

public ConcatValues withJoin(java.lang.String join)

setStrict

public void setStrict(boolean strict)

Forces all the input contexts found to generate the concatenation.

isStrict

public boolean isStrict()

Forces all the input contexts found to generate the concatenation.

withStrict

public ConcatValues withStrict(boolean strict)

withStrict

public ConcatValues withStrict(java.lang.Boolean strict)

setAllowDuplicates

public void setAllowDuplicates(boolean allowDuplicates)

If true, and if there are multiple DocumentChunks with the same ContextName, it concatenates them all.
If false, only the first DocumentChunk among all those with the same ContextName is kept.

isAllowDuplicates

public boolean isAllowDuplicates()

If true, and if there are multiple DocumentChunks with the same ContextName, it concatenates them all.
If false, only the first DocumentChunk among all those with the same ContextName is kept.

withAllowDuplicates

public ConcatValues withAllowDuplicates(boolean allowDuplicates)

withAllowDuplicates

public ConcatValues withAllowDuplicates(java.lang.Boolean allowDuplicates)

setCartesianProduct

public void setCartesianProduct(boolean cartesianProduct)

If there are multiple DocumentChunks with the same ContextName, it generates the cartesian product between all values.

isCartesianProduct

public boolean isCartesianProduct()

If there are multiple DocumentChunks with the same ContextName, it generates the cartesian product between all values.

withCartesianProduct

public ConcatValues withCartesianProduct(boolean cartesianProduct)

withCartesianProduct

public ConcatValues withCartesianProduct(java.lang.Boolean cartesianProduct)

makeCopy

public ConcatValues makeCopy()

Creates and returns a deep copy of this ConcatValues.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

Read this ConcatValues 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 ConcatValues as an XML fragment

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConcatValues.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConcatValues.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this ConcatValues.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MultiContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class MultiContextDocumentProcessor

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