com.exalead.indexing.analysis.v10

Class MathDocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MathDocumentProcessor

All Implemented Interfaces:

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

public class MathDocumentProcessor
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Performs mathematical operations on a numerical field. Expressions must be prefaced by a $.
For example, the expression `$ht_price * 1.196` finds the first chunk in the `ht_price` context, and replaces all occurrences of `ht_price` with the mathematical expression.
The result will be a new text chunk, either in the Output context (if specified), or in the original `ht_price` context.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_FLOATING_POINT
java.lang.String	expression
boolean	floatingPoint
java.lang.String	outputContext

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
MathDocumentProcessor()
MathDocumentProcessor(MathDocumentProcessor o) Copy constructor
MathDocumentProcessor(java.lang.String expression, java.lang.String outputContext)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this MathDocumentProcessor.
static MathDocumentProcessor	fromString(java.lang.String s) String representation of this MathDocumentProcessor.
java.lang.String	getExpression() Arithmetic expression to evaluate. For example: "$file_size + 42"
java.lang.String	getOutputContext() ContextName of the chunk to create.
boolean	isFloatingPoint() Output: A floating point number instead of the default integer one.
MathDocumentProcessor	makeCopy() Creates and returns a deep copy of this MathDocumentProcessor.
static MathDocumentProcessor	readFrom(java.io.InputStream is) Read this MathDocumentProcessor from an XML fragment.
void	setExpression(java.lang.String expression) Arithmetic expression to evaluate. For example: "$file_size + 42"
void	setFloatingPoint(boolean floatingPoint) Output: A floating point number instead of the default integer one.
void	setOutputContext(java.lang.String outputContext) ContextName of the chunk to create.
java.lang.String	toString() String representation of this MathDocumentProcessor.
MathDocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
MathDocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
MathDocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
MathDocumentProcessor	withDataModelState(java.lang.String dataModelState)
MathDocumentProcessor	withDisabled(boolean disabled)
MathDocumentProcessor	withDisabled(java.lang.Boolean disabled)
MathDocumentProcessor	withExpression(java.lang.String expression)
MathDocumentProcessor	withFloatingPoint(boolean floatingPoint)
MathDocumentProcessor	withFloatingPoint(java.lang.Boolean floatingPoint)
MathDocumentProcessor	withFromDataModel(DocumentProcessor fromDataModel)
MathDocumentProcessor	withName(java.lang.String name)
MathDocumentProcessor	withOutputContext(java.lang.String outputContext)
void	writeTo(java.io.OutputStream os) Write this MathDocumentProcessor as an XML fragment

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

expression

public java.lang.String expression

outputContext

public java.lang.String outputContext

floatingPoint

public boolean floatingPoint

DEFAULT_FLOATING_POINT

public static final boolean DEFAULT_FLOATING_POINT

See Also:

Constant Field Values

Constructor Detail

MathDocumentProcessor

public MathDocumentProcessor()

MathDocumentProcessor

public MathDocumentProcessor(java.lang.String expression,
                             java.lang.String outputContext)

MathDocumentProcessor

public MathDocumentProcessor(MathDocumentProcessor o)

Copy constructor

Method Detail

withAcceptCondition

public MathDocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public MathDocumentProcessor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public MathDocumentProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public MathDocumentProcessor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public MathDocumentProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public MathDocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public MathDocumentProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public MathDocumentProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setExpression

public void setExpression(java.lang.String expression)

Arithmetic expression to evaluate.
For example: "$file_size + 42"

getExpression

public java.lang.String getExpression()

Arithmetic expression to evaluate.
For example: "$file_size + 42"

withExpression

public MathDocumentProcessor withExpression(java.lang.String expression)

setOutputContext

public void setOutputContext(java.lang.String outputContext)

ContextName of the chunk to create.

getOutputContext

public java.lang.String getOutputContext()

ContextName of the chunk to create.

withOutputContext

public MathDocumentProcessor withOutputContext(java.lang.String outputContext)

setFloatingPoint

public void setFloatingPoint(boolean floatingPoint)

Output: A floating point number instead of the default integer one.

isFloatingPoint

public boolean isFloatingPoint()

Output: A floating point number instead of the default integer one.

withFloatingPoint

public MathDocumentProcessor withFloatingPoint(boolean floatingPoint)

withFloatingPoint

public MathDocumentProcessor withFloatingPoint(java.lang.Boolean floatingPoint)

makeCopy

public MathDocumentProcessor makeCopy()

Creates and returns a deep copy of this MathDocumentProcessor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

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

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MathDocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MathDocumentProcessor.

Overrides:

toString in class DocumentProcessor

check

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

Checks this MathDocumentProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

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