com.exalead.indexing.analysis.v10

Class FixedRangeNumericalPartitioning

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.FixedRangeNumericalPartitioning

All Implemented Interfaces:

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

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

Matches numerical values in a range. It transforms a numerical value into a matching range, based on a fixed range size.
For example, with rangeSize = 100,

• 101 -> 100_199
• 234 -> 200_299

It also works for negative numbers:

• -20 -> -100_-1
• 0 -> 0_99

This helps to create categories (for navigation) from numerical values.

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
static long	DEFAULT_RANGE_SIZE
static java.lang.String	DEFAULT_SEPARATOR
java.lang.String	outputContext
long	rangeSize
java.lang.String	separator

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
FixedRangeNumericalPartitioning()
FixedRangeNumericalPartitioning(FixedRangeNumericalPartitioning 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 FixedRangeNumericalPartitioning.
static FixedRangeNumericalPartitioning	fromString(java.lang.String s) String representation of this FixedRangeNumericalPartitioning.
java.lang.String	getOutputContext() The ContextName used for newly created chunks.
long	getRangeSize() The size of the range to consider.
java.lang.String	getSeparator() The range separator.
FixedRangeNumericalPartitioning	makeCopy() Creates and returns a deep copy of this FixedRangeNumericalPartitioning.
static FixedRangeNumericalPartitioning	readFrom(java.io.InputStream is) Read this FixedRangeNumericalPartitioning from an XML fragment.
void	setOutputContext(java.lang.String outputContext) The ContextName used for newly created chunks.
void	setRangeSize(long rangeSize) The size of the range to consider.
void	setSeparator(java.lang.String separator) The range separator.
java.lang.String	toString() String representation of this FixedRangeNumericalPartitioning.
FixedRangeNumericalPartitioning	withAcceptCondition(AcceptCondition acceptCondition)
FixedRangeNumericalPartitioning	withDataModelClass(java.lang.String dataModelClass)
FixedRangeNumericalPartitioning	withDataModelProperty(java.lang.String dataModelProperty)
FixedRangeNumericalPartitioning	withDataModelState(java.lang.String dataModelState)
FixedRangeNumericalPartitioning	withDisabled(boolean disabled)
FixedRangeNumericalPartitioning	withDisabled(java.lang.Boolean disabled)
FixedRangeNumericalPartitioning	withFromDataModel(DocumentProcessor fromDataModel)
FixedRangeNumericalPartitioning	withInputContext(java.lang.String inputContext)
FixedRangeNumericalPartitioning	withName(java.lang.String name)
FixedRangeNumericalPartitioning	withOutputContext(java.lang.String outputContext)
FixedRangeNumericalPartitioning	withRangeSize(long rangeSize)
FixedRangeNumericalPartitioning	withRangeSize(java.lang.Long rangeSize)
FixedRangeNumericalPartitioning	withSeparator(java.lang.String separator)
void	writeTo(java.io.OutputStream os) Write this FixedRangeNumericalPartitioning 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

outputContext

public java.lang.String outputContext

separator

public java.lang.String separator

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

See Also:

Constant Field Values

rangeSize

public long rangeSize

DEFAULT_RANGE_SIZE

public static final long DEFAULT_RANGE_SIZE

See Also:

Constant Field Values

Constructor Detail

FixedRangeNumericalPartitioning

public FixedRangeNumericalPartitioning()

FixedRangeNumericalPartitioning

public FixedRangeNumericalPartitioning(FixedRangeNumericalPartitioning o)

Copy constructor

Method Detail

withInputContext

public FixedRangeNumericalPartitioning withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public FixedRangeNumericalPartitioning withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public FixedRangeNumericalPartitioning withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public FixedRangeNumericalPartitioning withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public FixedRangeNumericalPartitioning withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public FixedRangeNumericalPartitioning withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public FixedRangeNumericalPartitioning withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public FixedRangeNumericalPartitioning withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public FixedRangeNumericalPartitioning withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

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

setSeparator

public void setSeparator(java.lang.String separator)

The range separator.

getSeparator

public java.lang.String getSeparator()

The range separator.

withSeparator

public FixedRangeNumericalPartitioning withSeparator(java.lang.String separator)

setRangeSize

public void setRangeSize(long rangeSize)

The size of the range to consider.

getRangeSize

public long getRangeSize()

The size of the range to consider.

withRangeSize

public FixedRangeNumericalPartitioning withRangeSize(long rangeSize)

withRangeSize

public FixedRangeNumericalPartitioning withRangeSize(java.lang.Long rangeSize)

makeCopy

public FixedRangeNumericalPartitioning makeCopy()

Creates and returns a deep copy of this FixedRangeNumericalPartitioning.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FixedRangeNumericalPartitioning.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FixedRangeNumericalPartitioning.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this FixedRangeNumericalPartitioning.

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