com.exalead.indexing.analysis.v10

Class MultiContextCSVEncoder

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextCSVEncoder

All Implemented Interfaces:

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

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

Creates a DocumentChunk containing the ContextName and the textual value of the DocumentChunks matching 'inputContexts'.
This processor can be used, for instance, to store arbitrary (key,value) pairs into one single index field.
Note that this storing method is inefficient and should be used with caution.

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
static boolean	DEFAULT_PROCESS_UNMAPPED_CONTEXTS
java.lang.String	outputContext
boolean	processUnmappedContexts

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
MultiContextCSVEncoder()
MultiContextCSVEncoder(MultiContextCSVEncoder 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 MultiContextCSVEncoder.
static MultiContextCSVEncoder	fromString(java.lang.String s) String representation of this MultiContextCSVEncoder.
java.lang.String	getOutputContext() The ContextName used for newly created chunks.
boolean	isProcessUnmappedContexts() All DocumentChunks with an unmapped ContextName in the document will be used for input. This can be used to emulate the 'default meta' and 'content' field feature of CloudView 4.6.
MultiContextCSVEncoder	makeCopy() Creates and returns a deep copy of this MultiContextCSVEncoder.
static MultiContextCSVEncoder	readFrom(java.io.InputStream is) Read this MultiContextCSVEncoder from an XML fragment.
void	setOutputContext(java.lang.String outputContext) The ContextName used for newly created chunks.
void	setProcessUnmappedContexts(boolean processUnmappedContexts) All DocumentChunks with an unmapped ContextName in the document will be used for input. This can be used to emulate the 'default meta' and 'content' field feature of CloudView 4.6.
java.lang.String	toString() String representation of this MultiContextCSVEncoder.
MultiContextCSVEncoder	withAcceptCondition(AcceptCondition acceptCondition)
MultiContextCSVEncoder	withDataModelClass(java.lang.String dataModelClass)
MultiContextCSVEncoder	withDataModelProperty(java.lang.String dataModelProperty)
MultiContextCSVEncoder	withDataModelState(java.lang.String dataModelState)
MultiContextCSVEncoder	withDisabled(boolean disabled)
MultiContextCSVEncoder	withDisabled(java.lang.Boolean disabled)
MultiContextCSVEncoder	withFromDataModel(DocumentProcessor fromDataModel)
MultiContextCSVEncoder	withInputContexts(java.util.Collection<StringValue> __values)
MultiContextCSVEncoder	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
MultiContextCSVEncoder	withName(java.lang.String name)
MultiContextCSVEncoder	withOutputContext(java.lang.String outputContext)
MultiContextCSVEncoder	withProcessUnmappedContexts(boolean processUnmappedContexts)
MultiContextCSVEncoder	withProcessUnmappedContexts(java.lang.Boolean processUnmappedContexts)
void	writeTo(java.io.OutputStream os) Write this MultiContextCSVEncoder 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

processUnmappedContexts

public boolean processUnmappedContexts

DEFAULT_PROCESS_UNMAPPED_CONTEXTS

public static final boolean DEFAULT_PROCESS_UNMAPPED_CONTEXTS

See Also:

Constant Field Values

Constructor Detail

MultiContextCSVEncoder

public MultiContextCSVEncoder()

MultiContextCSVEncoder

public MultiContextCSVEncoder(MultiContextCSVEncoder o)

Copy constructor

Method Detail

withInputContexts

public MultiContextCSVEncoder 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 MultiContextCSVEncoder withInputContexts(java.util.Collection<StringValue> __values)

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public MultiContextCSVEncoder withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public MultiContextCSVEncoder withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public MultiContextCSVEncoder withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public MultiContextCSVEncoder withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public MultiContextCSVEncoder withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public MultiContextCSVEncoder withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public MultiContextCSVEncoder withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public MultiContextCSVEncoder withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

The ContextName used for newly created chunks.

getOutputContext

public java.lang.String getOutputContext()

The ContextName used for newly created chunks.

withOutputContext

public MultiContextCSVEncoder withOutputContext(java.lang.String outputContext)

setProcessUnmappedContexts

public void setProcessUnmappedContexts(boolean processUnmappedContexts)

All DocumentChunks with an unmapped ContextName in the document will be used for input.
This can be used to emulate the 'default meta' and 'content' field feature of CloudView 4.6.

isProcessUnmappedContexts

public boolean isProcessUnmappedContexts()

All DocumentChunks with an unmapped ContextName in the document will be used for input.
This can be used to emulate the 'default meta' and 'content' field feature of CloudView 4.6.

withProcessUnmappedContexts

public MultiContextCSVEncoder withProcessUnmappedContexts(boolean processUnmappedContexts)

withProcessUnmappedContexts

public MultiContextCSVEncoder withProcessUnmappedContexts(java.lang.Boolean processUnmappedContexts)

makeCopy

public MultiContextCSVEncoder makeCopy()

Creates and returns a deep copy of this MultiContextCSVEncoder.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MultiContextCSVEncoder.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MultiContextCSVEncoder.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this MultiContextCSVEncoder.

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