com.exalead.mot.components.semanticextractor

Class FloatingPointEntity

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.components.semanticextractor.AbstractEntity

com.exalead.mot.components.semanticextractor.SimpleEntity

com.exalead.mot.components.semanticextractor.ValuedEntity

com.exalead.mot.components.semanticextractor.FloatingPointEntity

All Implemented Interfaces:

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

public class FloatingPointEntity
extends ValuedEntity
implements com.exalead.util.Checkable, java.io.Serializable

Matches floating-point numbers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

ValuedEntity.RightContexts, ValuedEntity.Units

Nested classes/interfaces inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

SimpleEntity.LeftContexts, SimpleEntity.Triggers

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addExactValue
double	coefficient
static boolean	DEFAULT_ADD_EXACT_VALUE
static double	DEFAULT_COEFFICIENT
static boolean	DEFAULT_HANDLE_OUT_OF_BOUND_VALUES
static double	DEFAULT_MAX
static double	DEFAULT_MIN
static int	DEFAULT_PRECISION
static double	DEFAULT_STEP
static boolean	DEFAULT_TRUNCATE_TRAILING_ZEROS
boolean	handleOutOfBoundValues
double	max
double	min
int	precision
double	step
boolean	truncateTrailingZeros

Fields inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

rightContext, rightContexts, unit, units

Fields inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

annotation, DEFAULT_MATCH_MODE, display, leftContext, leftContexts, matchMode, trigger, triggers

Fields inherited from class com.exalead.mot.components.semanticextractor.AbstractEntity

name

Fields inherited from class com.exalead.linguistic.v10.Modifiable

modifiedAt, modifiedBy

Constructor Summary

Constructors

Constructor and Description
FloatingPointEntity()
FloatingPointEntity(FloatingPointEntity o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FloatingPointEntity.
static FloatingPointEntity	fromString(java.lang.String s) String representation of this FloatingPointEntity.
double	getCoefficient() The normalization coefficient used to multiply the matched value
double	getMax() Maximum value for a match
double	getMin() Minimum value for a match
int	getPrecision() The floating-point precision in output
double	getStep() If defined, normalizes the value to the nearest step
boolean	isAddExactValue() If true, adds the original value (before normalization) in an extra annotation TAG.exact
boolean	isHandleOutOfBoundValues() If false, ignores values lower than min or greater than max
boolean	isTruncateTrailingZeros() If true, removes the trailing zeros after point
FloatingPointEntity	makeCopy() Creates and returns a deep copy of this FloatingPointEntity.
static FloatingPointEntity	readFrom(java.io.InputStream is) Read this FloatingPointEntity from an XML fragment.
void	setAddExactValue(boolean addExactValue) If true, adds the original value (before normalization) in an extra annotation TAG.exact
void	setCoefficient(double coefficient) The normalization coefficient used to multiply the matched value
void	setHandleOutOfBoundValues(boolean handleOutOfBoundValues) If false, ignores values lower than min or greater than max
void	setMax(double max) Maximum value for a match
void	setMin(double min) Minimum value for a match
void	setPrecision(int precision) The floating-point precision in output
void	setStep(double step) If defined, normalizes the value to the nearest step
void	setTruncateTrailingZeros(boolean truncateTrailingZeros) If true, removes the trailing zeros after point
java.lang.String	toString() String representation of this FloatingPointEntity.
FloatingPointEntity	withAddExactValue(boolean addExactValue)
FloatingPointEntity	withAddExactValue(java.lang.Boolean addExactValue)
FloatingPointEntity	withAnnotation(java.lang.String annotation)
FloatingPointEntity	withCoefficient(double coefficient)
FloatingPointEntity	withDisplay(java.lang.String display)
FloatingPointEntity	withHandleOutOfBoundValues(boolean handleOutOfBoundValues)
FloatingPointEntity	withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)
FloatingPointEntity	withLeftContext(java.lang.String leftContext)
FloatingPointEntity	withLeftContexts(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointEntity	withLeftContexts(exa.bee.StringValue... __values) Alias for triggers
FloatingPointEntity	withMatchMode(java.lang.String matchMode)
FloatingPointEntity	withMax(double max)
FloatingPointEntity	withMin(double min)
FloatingPointEntity	withModifiedAt(java.lang.Long modifiedAt)
FloatingPointEntity	withModifiedBy(java.lang.String modifiedBy)
FloatingPointEntity	withName(java.lang.String name)
FloatingPointEntity	withPrecision(int precision)
FloatingPointEntity	withPrecision(java.lang.Integer precision)
FloatingPointEntity	withRightContext(java.lang.String rightContext)
FloatingPointEntity	withRightContexts(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointEntity	withRightContexts(exa.bee.StringValue... __values) Alias for units
FloatingPointEntity	withStep(double step)
FloatingPointEntity	withTrigger(java.lang.String trigger)
FloatingPointEntity	withTriggers(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointEntity	withTriggers(exa.bee.StringValue... __values) An optional list of left contexts triggering the match
FloatingPointEntity	withTruncateTrailingZeros(boolean truncateTrailingZeros)
FloatingPointEntity	withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)
FloatingPointEntity	withUnit(java.lang.String unit)
FloatingPointEntity	withUnits(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointEntity	withUnits(exa.bee.StringValue... __values) An optional list of conditions on right context
void	writeTo(java.io.OutputStream os) Write this FloatingPointEntity as an XML fragment

Methods inherited from class com.exalead.mot.components.semanticextractor.ValuedEntity

getRightContext, getRightContexts, getUnit, getUnits, setRightContext, setRightContexts, setUnit, setUnits, withRightContexts, withUnits

Methods inherited from class com.exalead.mot.components.semanticextractor.SimpleEntity

getAnnotation, getDisplay, getLeftContext, getLeftContexts, getMatchMode, getTrigger, getTriggers, setAnnotation, setDisplay, setLeftContext, setLeftContexts, setMatchMode, setTrigger, setTriggers, withLeftContexts, withTriggers

Methods inherited from class com.exalead.mot.components.semanticextractor.AbstractEntity

getName, setName

Methods inherited from class com.exalead.linguistic.v10.Modifiable

getModifiedAt, getModifiedBy, setModifiedAt, setModifiedBy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

step

public double step

DEFAULT_STEP

public static final double DEFAULT_STEP

See Also:

Constant Field Values

min

public double min

DEFAULT_MIN

public static final double DEFAULT_MIN

See Also:

Constant Field Values

max

public double max

DEFAULT_MAX

public static final double DEFAULT_MAX

See Also:

Constant Field Values

coefficient

public double coefficient

DEFAULT_COEFFICIENT

public static final double DEFAULT_COEFFICIENT

See Also:

Constant Field Values

precision

public int precision

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

handleOutOfBoundValues

public boolean handleOutOfBoundValues

DEFAULT_HANDLE_OUT_OF_BOUND_VALUES

public static final boolean DEFAULT_HANDLE_OUT_OF_BOUND_VALUES

See Also:

Constant Field Values

addExactValue

public boolean addExactValue

DEFAULT_ADD_EXACT_VALUE

public static final boolean DEFAULT_ADD_EXACT_VALUE

See Also:

Constant Field Values

truncateTrailingZeros

public boolean truncateTrailingZeros

DEFAULT_TRUNCATE_TRAILING_ZEROS

public static final boolean DEFAULT_TRUNCATE_TRAILING_ZEROS

See Also:

Constant Field Values

Constructor Detail

FloatingPointEntity

public FloatingPointEntity()

FloatingPointEntity

public FloatingPointEntity(FloatingPointEntity o)

Copy constructor

Method Detail

withUnit

public FloatingPointEntity withUnit(java.lang.String unit)

Overrides:

withUnit in class ValuedEntity

withUnits

public FloatingPointEntity withUnits(exa.bee.StringValue... __values)

An optional list of conditions on right context

Overrides:

withUnits in class ValuedEntity

withUnits

public FloatingPointEntity withUnits(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withUnits in class ValuedEntity

withRightContext

public FloatingPointEntity withRightContext(java.lang.String rightContext)

Overrides:

withRightContext in class ValuedEntity

withRightContexts

public FloatingPointEntity withRightContexts(exa.bee.StringValue... __values)

Alias for units

Overrides:

withRightContexts in class ValuedEntity

withRightContexts

public FloatingPointEntity withRightContexts(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withRightContexts in class ValuedEntity

withTrigger

public FloatingPointEntity withTrigger(java.lang.String trigger)

Overrides:

withTrigger in class ValuedEntity

withTriggers

public FloatingPointEntity withTriggers(exa.bee.StringValue... __values)

An optional list of left contexts triggering the match

Overrides:

withTriggers in class ValuedEntity

withTriggers

public FloatingPointEntity withTriggers(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withTriggers in class ValuedEntity

withLeftContext

public FloatingPointEntity withLeftContext(java.lang.String leftContext)

Overrides:

withLeftContext in class ValuedEntity

withLeftContexts

public FloatingPointEntity withLeftContexts(exa.bee.StringValue... __values)

Alias for triggers

Overrides:

withLeftContexts in class ValuedEntity

withLeftContexts

public FloatingPointEntity withLeftContexts(java.util.Collection<exa.bee.StringValue> __values)

Overrides:

withLeftContexts in class ValuedEntity

withAnnotation

public FloatingPointEntity withAnnotation(java.lang.String annotation)

Overrides:

withAnnotation in class ValuedEntity

withDisplay

public FloatingPointEntity withDisplay(java.lang.String display)

Overrides:

withDisplay in class ValuedEntity

withMatchMode

public FloatingPointEntity withMatchMode(java.lang.String matchMode)

Overrides:

withMatchMode in class ValuedEntity

withName

public FloatingPointEntity withName(java.lang.String name)

Overrides:

withName in class ValuedEntity

withModifiedBy

public FloatingPointEntity withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class ValuedEntity

withModifiedAt

public FloatingPointEntity withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class ValuedEntity

setStep

public void setStep(double step)

If defined, normalizes the value to the nearest step

getStep

public double getStep()

If defined, normalizes the value to the nearest step

withStep

public FloatingPointEntity withStep(double step)

setMin

public void setMin(double min)

Minimum value for a match

getMin

public double getMin()

Minimum value for a match

withMin

public FloatingPointEntity withMin(double min)

setMax

public void setMax(double max)

Maximum value for a match

getMax

public double getMax()

Maximum value for a match

withMax

public FloatingPointEntity withMax(double max)

setCoefficient

public void setCoefficient(double coefficient)

The normalization coefficient used to multiply the matched value

getCoefficient

public double getCoefficient()

The normalization coefficient used to multiply the matched value

withCoefficient

public FloatingPointEntity withCoefficient(double coefficient)

setPrecision

public void setPrecision(int precision)

The floating-point precision in output

getPrecision

public int getPrecision()

The floating-point precision in output

withPrecision

public FloatingPointEntity withPrecision(int precision)

withPrecision

public FloatingPointEntity withPrecision(java.lang.Integer precision)

setHandleOutOfBoundValues

public void setHandleOutOfBoundValues(boolean handleOutOfBoundValues)

If false, ignores values lower than min or greater than max

isHandleOutOfBoundValues

public boolean isHandleOutOfBoundValues()

If false, ignores values lower than min or greater than max

withHandleOutOfBoundValues

public FloatingPointEntity withHandleOutOfBoundValues(boolean handleOutOfBoundValues)

withHandleOutOfBoundValues

public FloatingPointEntity withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)

setAddExactValue

public void setAddExactValue(boolean addExactValue)

If true, adds the original value (before normalization) in an extra annotation TAG.exact

isAddExactValue

public boolean isAddExactValue()

If true, adds the original value (before normalization) in an extra annotation TAG.exact

withAddExactValue

public FloatingPointEntity withAddExactValue(boolean addExactValue)

withAddExactValue

public FloatingPointEntity withAddExactValue(java.lang.Boolean addExactValue)

setTruncateTrailingZeros

public void setTruncateTrailingZeros(boolean truncateTrailingZeros)

If true, removes the trailing zeros after point

isTruncateTrailingZeros

public boolean isTruncateTrailingZeros()

If true, removes the trailing zeros after point

withTruncateTrailingZeros

public FloatingPointEntity withTruncateTrailingZeros(boolean truncateTrailingZeros)

withTruncateTrailingZeros

public FloatingPointEntity withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)

makeCopy

public FloatingPointEntity makeCopy()

Creates and returns a deep copy of this FloatingPointEntity.

Overrides:

makeCopy in class ValuedEntity

readFrom

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

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

Overrides:

writeTo in class ValuedEntity

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FloatingPointEntity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FloatingPointEntity.

Overrides:

toString in class ValuedEntity

check

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

Checks this FloatingPointEntity.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValuedEntity

Throws:

com.exalead.util.TypedException