com.exalead.mot.components.semanticextractor

Class IntegerEntity

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.IntegerEntity

All Implemented Interfaces:

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

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

Matches integral 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 int	DEFAULT_MAX
static int	DEFAULT_MIN
static int	DEFAULT_PRECISION
static int	DEFAULT_STEP
static boolean	DEFAULT_TRUNCATE_TRAILING_ZEROS
boolean	handleOutOfBoundValues
int	max
int	min
int	precision
int	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
IntegerEntity()
IntegerEntity(IntegerEntity o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IntegerEntity.
static IntegerEntity	fromString(java.lang.String s) String representation of this IntegerEntity.
double	getCoefficient() The normalization coefficient used to multiply the matched value
int	getMax() Maximum value for a match
int	getMin() Minimum value for a match
int	getPrecision() The floating-point precision in output
int	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
IntegerEntity	makeCopy() Creates and returns a deep copy of this IntegerEntity.
static IntegerEntity	readFrom(java.io.InputStream is) Read this IntegerEntity 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(int max) Maximum value for a match
void	setMin(int min) Minimum value for a match
void	setPrecision(int precision) The floating-point precision in output
void	setStep(int 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 IntegerEntity.
IntegerEntity	withAddExactValue(boolean addExactValue)
IntegerEntity	withAddExactValue(java.lang.Boolean addExactValue)
IntegerEntity	withAnnotation(java.lang.String annotation)
IntegerEntity	withCoefficient(double coefficient)
IntegerEntity	withDisplay(java.lang.String display)
IntegerEntity	withHandleOutOfBoundValues(boolean handleOutOfBoundValues)
IntegerEntity	withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)
IntegerEntity	withLeftContext(java.lang.String leftContext)
IntegerEntity	withLeftContexts(java.util.Collection<exa.bee.StringValue> __values)
IntegerEntity	withLeftContexts(exa.bee.StringValue... __values) Alias for triggers
IntegerEntity	withMatchMode(java.lang.String matchMode)
IntegerEntity	withMax(int max)
IntegerEntity	withMax(java.lang.Integer max)
IntegerEntity	withMin(int min)
IntegerEntity	withMin(java.lang.Integer min)
IntegerEntity	withModifiedAt(java.lang.Long modifiedAt)
IntegerEntity	withModifiedBy(java.lang.String modifiedBy)
IntegerEntity	withName(java.lang.String name)
IntegerEntity	withPrecision(int precision)
IntegerEntity	withPrecision(java.lang.Integer precision)
IntegerEntity	withRightContext(java.lang.String rightContext)
IntegerEntity	withRightContexts(java.util.Collection<exa.bee.StringValue> __values)
IntegerEntity	withRightContexts(exa.bee.StringValue... __values) Alias for units
IntegerEntity	withStep(int step)
IntegerEntity	withStep(java.lang.Integer step)
IntegerEntity	withTrigger(java.lang.String trigger)
IntegerEntity	withTriggers(java.util.Collection<exa.bee.StringValue> __values)
IntegerEntity	withTriggers(exa.bee.StringValue... __values) An optional list of left contexts triggering the match
IntegerEntity	withTruncateTrailingZeros(boolean truncateTrailingZeros)
IntegerEntity	withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)
IntegerEntity	withUnit(java.lang.String unit)
IntegerEntity	withUnits(java.util.Collection<exa.bee.StringValue> __values)
IntegerEntity	withUnits(exa.bee.StringValue... __values) An optional list of conditions on right context
void	writeTo(java.io.OutputStream os) Write this IntegerEntity 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 int step

DEFAULT_STEP

public static final int DEFAULT_STEP

See Also:

Constant Field Values

min

public int min

DEFAULT_MIN

public static final int DEFAULT_MIN

See Also:

Constant Field Values

max

public int max

DEFAULT_MAX

public static final int 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

IntegerEntity

public IntegerEntity()

IntegerEntity

public IntegerEntity(IntegerEntity o)

Copy constructor

Method Detail

withUnit

public IntegerEntity withUnit(java.lang.String unit)

Overrides:

withUnit in class ValuedEntity

withUnits

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

An optional list of conditions on right context

Overrides:

withUnits in class ValuedEntity

withUnits

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

Overrides:

withUnits in class ValuedEntity

withRightContext

public IntegerEntity withRightContext(java.lang.String rightContext)

Overrides:

withRightContext in class ValuedEntity

withRightContexts

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

Alias for units

Overrides:

withRightContexts in class ValuedEntity

withRightContexts

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

Overrides:

withRightContexts in class ValuedEntity

withTrigger

public IntegerEntity withTrigger(java.lang.String trigger)

Overrides:

withTrigger in class ValuedEntity

withTriggers

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

An optional list of left contexts triggering the match

Overrides:

withTriggers in class ValuedEntity

withTriggers

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

Overrides:

withTriggers in class ValuedEntity

withLeftContext

public IntegerEntity withLeftContext(java.lang.String leftContext)

Overrides:

withLeftContext in class ValuedEntity

withLeftContexts

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

Alias for triggers

Overrides:

withLeftContexts in class ValuedEntity

withLeftContexts

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

Overrides:

withLeftContexts in class ValuedEntity

withAnnotation

public IntegerEntity withAnnotation(java.lang.String annotation)

Overrides:

withAnnotation in class ValuedEntity

withDisplay

public IntegerEntity withDisplay(java.lang.String display)

Overrides:

withDisplay in class ValuedEntity

withMatchMode

public IntegerEntity withMatchMode(java.lang.String matchMode)

Overrides:

withMatchMode in class ValuedEntity

withName

public IntegerEntity withName(java.lang.String name)

Overrides:

withName in class ValuedEntity

withModifiedBy

public IntegerEntity withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class ValuedEntity

withModifiedAt

public IntegerEntity withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class ValuedEntity

setStep

public void setStep(int step)

If defined, normalizes the value to the nearest step

getStep

public int getStep()

If defined, normalizes the value to the nearest step

withStep

public IntegerEntity withStep(int step)

withStep

public IntegerEntity withStep(java.lang.Integer step)

setMin

public void setMin(int min)

Minimum value for a match

getMin

public int getMin()

Minimum value for a match

withMin

public IntegerEntity withMin(int min)

withMin

public IntegerEntity withMin(java.lang.Integer min)

setMax

public void setMax(int max)

Maximum value for a match

getMax

public int getMax()

Maximum value for a match

withMax

public IntegerEntity withMax(int max)

withMax

public IntegerEntity withMax(java.lang.Integer 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 IntegerEntity 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 IntegerEntity withPrecision(int precision)

withPrecision

public IntegerEntity 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 IntegerEntity withHandleOutOfBoundValues(boolean handleOutOfBoundValues)

withHandleOutOfBoundValues

public IntegerEntity 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 IntegerEntity withAddExactValue(boolean addExactValue)

withAddExactValue

public IntegerEntity 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 IntegerEntity withTruncateTrailingZeros(boolean truncateTrailingZeros)

withTruncateTrailingZeros

public IntegerEntity withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)

makeCopy

public IntegerEntity makeCopy()

Creates and returns a deep copy of this IntegerEntity.

Overrides:

makeCopy in class ValuedEntity

readFrom

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

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

Overrides:

writeTo in class ValuedEntity

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IntegerEntity.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IntegerEntity.

Overrides:

toString in class ValuedEntity

check

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

Checks this IntegerEntity.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValuedEntity

Throws:

com.exalead.util.TypedException