com.exalead.indexing.analysis.v10

Class TextToNum

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.TextToNum

All Implemented Interfaces:

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

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

Processor to hack an approximate sort on a text field.
Implements a surjection from the set of strings to the set of integers [0..N] with N close but inferior or equal to 18,446,744,073,709,551,615
User defines an ordered alphabet. A first surjection from the set of all strings to the set of finite sequences of symbols taken from this alphabet is applied (strip the string from symbols out of the alphabet).
A partial order relation is inferred on the latter set by the alphabet (lexicographical order).
For obvious cardinal numbers reasons (one set is infinite the other is not), the second surjection cannot be partial-order preserving. The idea is to preserve the relation on the shorter strings, AND preserve the relation between shorter strings and longer strings, such as:

• if STRING2ULONG('shortstring1') <= STRING2ULONG('shortstring2') then 'shortstring1' <= 'shortstring2'
• STRING2ULONG('longstring1') <= STRING2ULONG('longstring2') does NOT insure 'longstring1' <= 'longstring2'
• if STRING2ULONG('shortstring1') <= STRING2ULONG('longstring2') then 'shortstring1' <= 'longstring2'

The size of the prefix obviously depends on the size of the alphabet.

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

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
TextToNum()
TextToNum(TextToNum 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 TextToNum.
static TextToNum	fromString(java.lang.String s) String representation of this TextToNum.
java.lang.String	getAlphabet() The ordered alphabet.
int	getNbBits() Number of bits of unsigned field used for sorting.
java.lang.String	getOutputContext() The ContextName used for the newly created chunk.
TextToNum	makeCopy() Creates and returns a deep copy of this TextToNum.
static TextToNum	readFrom(java.io.InputStream is) Read this TextToNum from an XML fragment.
void	setAlphabet(java.lang.String alphabet) The ordered alphabet.
void	setNbBits(int nbBits) Number of bits of unsigned field used for sorting.
void	setOutputContext(java.lang.String outputContext) The ContextName used for the newly created chunk.
java.lang.String	toString() String representation of this TextToNum.
TextToNum	withAcceptCondition(AcceptCondition acceptCondition)
TextToNum	withAlphabet(java.lang.String alphabet)
TextToNum	withDataModelClass(java.lang.String dataModelClass)
TextToNum	withDataModelProperty(java.lang.String dataModelProperty)
TextToNum	withDataModelState(java.lang.String dataModelState)
TextToNum	withDisabled(boolean disabled)
TextToNum	withDisabled(java.lang.Boolean disabled)
TextToNum	withFromDataModel(DocumentProcessor fromDataModel)
TextToNum	withInputContext(java.lang.String inputContext)
TextToNum	withName(java.lang.String name)
TextToNum	withNbBits(int nbBits)
TextToNum	withNbBits(java.lang.Integer nbBits)
TextToNum	withOutputContext(java.lang.String outputContext)
void	writeTo(java.io.OutputStream os) Write this TextToNum 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

alphabet

public java.lang.String alphabet

DEFAULT_ALPHABET

public static final java.lang.String DEFAULT_ALPHABET

See Also:

Constant Field Values

outputContext

public java.lang.String outputContext

nbBits

public int nbBits

DEFAULT_NB_BITS

public static final int DEFAULT_NB_BITS

See Also:

Constant Field Values

Constructor Detail

TextToNum

public TextToNum()

TextToNum

public TextToNum(TextToNum o)

Copy constructor

Method Detail

withInputContext

public TextToNum withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public TextToNum withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public TextToNum withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public TextToNum withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public TextToNum withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public TextToNum withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public TextToNum withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public TextToNum withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public TextToNum withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setAlphabet

public void setAlphabet(java.lang.String alphabet)

The ordered alphabet.

getAlphabet

public java.lang.String getAlphabet()

The ordered alphabet.

withAlphabet

public TextToNum withAlphabet(java.lang.String alphabet)

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 TextToNum withOutputContext(java.lang.String outputContext)

setNbBits

public void setNbBits(int nbBits)

Number of bits of unsigned field used for sorting.

getNbBits

public int getNbBits()

Number of bits of unsigned field used for sorting.

withNbBits

public TextToNum withNbBits(int nbBits)

withNbBits

public TextToNum withNbBits(java.lang.Integer nbBits)

makeCopy

public TextToNum makeCopy()

Creates and returns a deep copy of this TextToNum.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TextToNum.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TextToNum.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this TextToNum.

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