com.exalead.indexing.analysis.v10

Class StringHash

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.StringHash

All Implemented Interfaces:

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

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

The StringHash processor computes a signed hash of the textual input value.
For example, this value can be used in a field used for grouping.

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 int	DEFAULT_NB_BITS
int	nbBits
java.lang.String	outputContext

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
StringHash()
StringHash(StringHash 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 StringHash.
static StringHash	fromString(java.lang.String s) String representation of this StringHash.
int	getNbBits() The size of the hash, in bits, including the sign bit.
java.lang.String	getOutputContext() The ContextName used for the newly created chunk.
StringHash	makeCopy() Creates and returns a deep copy of this StringHash.
static StringHash	readFrom(java.io.InputStream is) Read this StringHash from an XML fragment.
void	setNbBits(int nbBits) The size of the hash, in bits, including the sign bit.
void	setOutputContext(java.lang.String outputContext) The ContextName used for the newly created chunk.
java.lang.String	toString() String representation of this StringHash.
StringHash	withAcceptCondition(AcceptCondition acceptCondition)
StringHash	withDataModelClass(java.lang.String dataModelClass)
StringHash	withDataModelProperty(java.lang.String dataModelProperty)
StringHash	withDataModelState(java.lang.String dataModelState)
StringHash	withDisabled(boolean disabled)
StringHash	withDisabled(java.lang.Boolean disabled)
StringHash	withFromDataModel(DocumentProcessor fromDataModel)
StringHash	withInputContexts(java.util.Collection<StringValue> __values)
StringHash	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
StringHash	withName(java.lang.String name)
StringHash	withNbBits(int nbBits)
StringHash	withNbBits(java.lang.Integer nbBits)
StringHash	withOutputContext(java.lang.String outputContext)
void	writeTo(java.io.OutputStream os) Write this StringHash 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

nbBits

public int nbBits

DEFAULT_NB_BITS

public static final int DEFAULT_NB_BITS

See Also:

Constant Field Values

outputContext

public java.lang.String outputContext

Constructor Detail

StringHash

public StringHash()

StringHash

public StringHash(StringHash o)

Copy constructor

Method Detail

withInputContexts

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

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public StringHash withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public StringHash withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public StringHash withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public StringHash withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public StringHash withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public StringHash withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public StringHash withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public StringHash withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setNbBits

public void setNbBits(int nbBits)

The size of the hash, in bits, including the sign bit.
The hash values will be in [-2^(nbBits-1); 2^(nbBits-1) - 1].

getNbBits

public int getNbBits()

The size of the hash, in bits, including the sign bit.
The hash values will be in [-2^(nbBits-1); 2^(nbBits-1) - 1].

withNbBits

public StringHash withNbBits(int nbBits)

withNbBits

public StringHash withNbBits(java.lang.Integer nbBits)

setOutputContext

public void setOutputContext(java.lang.String outputContext)

The ContextName used for the newly created chunk.

getOutputContext

public java.lang.String getOutputContext()

The ContextName used for the newly created chunk.

withOutputContext

public StringHash withOutputContext(java.lang.String outputContext)

makeCopy

public StringHash makeCopy()

Creates and returns a deep copy of this StringHash.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this StringHash.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StringHash.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this StringHash.

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