com.exalead.indexing.analysis.v10

Class NumericalFormatter

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.NumericalFormatter

All Implemented Interfaces:

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

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

The Numerical Formatter processor creates valid numerical chunks from various number formats.

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
java.lang.String	decimalSeparator
static java.lang.String	DEFAULT_DECIMAL_SEPARATOR
static int	DEFAULT_PRECISION
static boolean	DEFAULT_REMOVE_TRAILING_ZEROS
static int	DEFAULT_ROUND
java.lang.String	groupSeparator
java.lang.String	outputContext
int	precision
boolean	removeTrailingZeros
int	round

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
NumericalFormatter()
NumericalFormatter(NumericalFormatter 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 NumericalFormatter.
static NumericalFormatter	fromString(java.lang.String s) String representation of this NumericalFormatter.
java.lang.String	getDecimalSeparator() decimal separator
java.lang.String	getGroupSeparator() group separator
java.lang.String	getOutputContext() The ContextName used for the newly created chunk. If null, it uses the same name as the input.
int	getPrecision() Number of digits relevant in the decimal part.
int	getRound() Rounds the integer part with this range.
boolean	isRemoveTrailingZeros() Removes the trailing zeros in the decimal part.
NumericalFormatter	makeCopy() Creates and returns a deep copy of this NumericalFormatter.
static NumericalFormatter	readFrom(java.io.InputStream is) Read this NumericalFormatter from an XML fragment.
void	setDecimalSeparator(java.lang.String decimalSeparator) decimal separator
void	setGroupSeparator(java.lang.String groupSeparator) group separator
void	setOutputContext(java.lang.String outputContext) The ContextName used for the newly created chunk. If null, it uses the same name as the input.
void	setPrecision(int precision) Number of digits relevant in the decimal part.
void	setRemoveTrailingZeros(boolean removeTrailingZeros) Removes the trailing zeros in the decimal part.
void	setRound(int round) Rounds the integer part with this range.
java.lang.String	toString() String representation of this NumericalFormatter.
NumericalFormatter	withAcceptCondition(AcceptCondition acceptCondition)
NumericalFormatter	withDataModelClass(java.lang.String dataModelClass)
NumericalFormatter	withDataModelProperty(java.lang.String dataModelProperty)
NumericalFormatter	withDataModelState(java.lang.String dataModelState)
NumericalFormatter	withDecimalSeparator(java.lang.String decimalSeparator)
NumericalFormatter	withDisabled(boolean disabled)
NumericalFormatter	withDisabled(java.lang.Boolean disabled)
NumericalFormatter	withFromDataModel(DocumentProcessor fromDataModel)
NumericalFormatter	withGroupSeparator(java.lang.String groupSeparator)
NumericalFormatter	withInputContexts(java.util.Collection<StringValue> __values)
NumericalFormatter	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
NumericalFormatter	withName(java.lang.String name)
NumericalFormatter	withOutputContext(java.lang.String outputContext)
NumericalFormatter	withPrecision(int precision)
NumericalFormatter	withPrecision(java.lang.Integer precision)
NumericalFormatter	withRemoveTrailingZeros(boolean removeTrailingZeros)
NumericalFormatter	withRemoveTrailingZeros(java.lang.Boolean removeTrailingZeros)
NumericalFormatter	withRound(int round)
NumericalFormatter	withRound(java.lang.Integer round)
void	writeTo(java.io.OutputStream os) Write this NumericalFormatter 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

precision

public int precision

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

round

public int round

DEFAULT_ROUND

public static final int DEFAULT_ROUND

See Also:

Constant Field Values

removeTrailingZeros

public boolean removeTrailingZeros

DEFAULT_REMOVE_TRAILING_ZEROS

public static final boolean DEFAULT_REMOVE_TRAILING_ZEROS

See Also:

Constant Field Values

groupSeparator

public java.lang.String groupSeparator

decimalSeparator

public java.lang.String decimalSeparator

DEFAULT_DECIMAL_SEPARATOR

public static final java.lang.String DEFAULT_DECIMAL_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

NumericalFormatter

public NumericalFormatter()

NumericalFormatter

public NumericalFormatter(NumericalFormatter o)

Copy constructor

Method Detail

withInputContexts

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

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public NumericalFormatter withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public NumericalFormatter withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public NumericalFormatter withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public NumericalFormatter withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public NumericalFormatter withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public NumericalFormatter withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public NumericalFormatter withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public NumericalFormatter withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

The ContextName used for the newly created chunk.
If null, it uses the same name as the input.

getOutputContext

public java.lang.String getOutputContext()

The ContextName used for the newly created chunk.
If null, it uses the same name as the input.

withOutputContext

public NumericalFormatter withOutputContext(java.lang.String outputContext)

setPrecision

public void setPrecision(int precision)

Number of digits relevant in the decimal part.

getPrecision

public int getPrecision()

Number of digits relevant in the decimal part.

withPrecision

public NumericalFormatter withPrecision(int precision)

withPrecision

public NumericalFormatter withPrecision(java.lang.Integer precision)

setRound

public void setRound(int round)

Rounds the integer part with this range.

getRound

public int getRound()

Rounds the integer part with this range.

withRound

public NumericalFormatter withRound(int round)

withRound

public NumericalFormatter withRound(java.lang.Integer round)

setRemoveTrailingZeros

public void setRemoveTrailingZeros(boolean removeTrailingZeros)

Removes the trailing zeros in the decimal part.

isRemoveTrailingZeros

public boolean isRemoveTrailingZeros()

Removes the trailing zeros in the decimal part.

withRemoveTrailingZeros

public NumericalFormatter withRemoveTrailingZeros(boolean removeTrailingZeros)

withRemoveTrailingZeros

public NumericalFormatter withRemoveTrailingZeros(java.lang.Boolean removeTrailingZeros)

setGroupSeparator

public void setGroupSeparator(java.lang.String groupSeparator)

group separator

getGroupSeparator

public java.lang.String getGroupSeparator()

group separator

withGroupSeparator

public NumericalFormatter withGroupSeparator(java.lang.String groupSeparator)

setDecimalSeparator

public void setDecimalSeparator(java.lang.String decimalSeparator)

decimal separator

getDecimalSeparator

public java.lang.String getDecimalSeparator()

decimal separator

withDecimalSeparator

public NumericalFormatter withDecimalSeparator(java.lang.String decimalSeparator)

makeCopy

public NumericalFormatter makeCopy()

Creates and returns a deep copy of this NumericalFormatter.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NumericalFormatter.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NumericalFormatter.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this NumericalFormatter.

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