com.exalead.mot.components.featuresextractor

Class NumericalFeature

java.lang.Object

com.exalead.mot.components.featuresextractor.Feature

com.exalead.mot.components.featuresextractor.ValuedFeature

com.exalead.mot.components.featuresextractor.NumericalFeature

All Implemented Interfaces:

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

public class NumericalFeature
extends ValuedFeature
implements com.exalead.util.Checkable, java.io.Serializable

step="100" min="0" max="2000" />
step="100" min="0" max="2000" coefficient="1000" />

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mot.components.featuresextractor.ValuedFeature

ValuedFeature.Units

Nested classes/interfaces inherited from class com.exalead.mot.components.featuresextractor.Feature

Feature.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.featuresextractor.ValuedFeature

unit, units

Fields inherited from class com.exalead.mot.components.featuresextractor.Feature

annotation, DEFAULT_LEVEL, display, level, trigger, triggers

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this NumericalFeature.
static NumericalFeature	fromString(java.lang.String s) String representation of this NumericalFeature.
double	getCoefficient() the coefficient used to multiply the extracted feature
int	getMax() the maximum value of the extracted feature
int	getMin() the minimum value of the extracted feature
int	getPrecision() the floating point precision in the display form
int	getStep() the optional step used
boolean	isAddExactValue() add the value (without any normalization) in a second annotation named TAG.exact
boolean	isHandleOutOfBoundValues() handle the value that are out of bound
boolean	isTruncateTrailingZeros() remove the trailing zeros after comma
NumericalFeature	makeCopy() Creates and returns a deep copy of this NumericalFeature.
static NumericalFeature	readFrom(java.io.InputStream is) Read this NumericalFeature from an XML fragment.
void	setAddExactValue(boolean addExactValue) add the value (without any normalization) in a second annotation named TAG.exact
void	setCoefficient(double coefficient) the coefficient used to multiply the extracted feature
void	setHandleOutOfBoundValues(boolean handleOutOfBoundValues) handle the value that are out of bound
void	setMax(int max) the maximum value of the extracted feature
void	setMin(int min) the minimum value of the extracted feature
void	setPrecision(int precision) the floating point precision in the display form
void	setStep(int step) the optional step used
void	setTruncateTrailingZeros(boolean truncateTrailingZeros) remove the trailing zeros after comma
java.lang.String	toString() String representation of this NumericalFeature.
NumericalFeature	withAddExactValue(boolean addExactValue)
NumericalFeature	withAddExactValue(java.lang.Boolean addExactValue)
NumericalFeature	withAnnotation(java.lang.String annotation)
NumericalFeature	withCoefficient(double coefficient)
NumericalFeature	withDisplay(java.lang.String display)
NumericalFeature	withHandleOutOfBoundValues(boolean handleOutOfBoundValues)
NumericalFeature	withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)
NumericalFeature	withLevel(java.lang.String level)
NumericalFeature	withMax(int max)
NumericalFeature	withMax(java.lang.Integer max)
NumericalFeature	withMin(int min)
NumericalFeature	withMin(java.lang.Integer min)
NumericalFeature	withPrecision(int precision)
NumericalFeature	withPrecision(java.lang.Integer precision)
NumericalFeature	withStep(int step)
NumericalFeature	withStep(java.lang.Integer step)
NumericalFeature	withTrigger(java.lang.String trigger)
NumericalFeature	withTriggers(java.util.Collection<exa.bee.StringValue> __values)
NumericalFeature	withTriggers(exa.bee.StringValue... __values)
NumericalFeature	withTruncateTrailingZeros(boolean truncateTrailingZeros)
NumericalFeature	withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)
NumericalFeature	withUnit(java.lang.String unit)
NumericalFeature	withUnits(java.util.Collection<exa.bee.StringValue> __values)
NumericalFeature	withUnits(exa.bee.StringValue... __values)
void	writeTo(java.io.OutputStream os) Write this NumericalFeature as an XML fragment

Methods inherited from class com.exalead.mot.components.featuresextractor.ValuedFeature

getUnit, getUnits, setUnit, setUnits, withUnits

Methods inherited from class com.exalead.mot.components.featuresextractor.Feature

getAnnotation, getDisplay, getLevel, getTrigger, getTriggers, setAnnotation, setDisplay, setLevel, setTrigger, setTriggers, withTriggers

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

NumericalFeature

public NumericalFeature()

NumericalFeature

public NumericalFeature(NumericalFeature o)

Copy constructor

Method Detail

withUnit

public NumericalFeature withUnit(java.lang.String unit)

Overrides:

withUnit in class ValuedFeature

withUnits

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

Overrides:

withUnits in class ValuedFeature

withUnits

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

Overrides:

withUnits in class ValuedFeature

withTrigger

public NumericalFeature withTrigger(java.lang.String trigger)

Overrides:

withTrigger in class ValuedFeature

withTriggers

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

Overrides:

withTriggers in class ValuedFeature

withTriggers

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

Overrides:

withTriggers in class ValuedFeature

withAnnotation

public NumericalFeature withAnnotation(java.lang.String annotation)

Overrides:

withAnnotation in class ValuedFeature

withDisplay

public NumericalFeature withDisplay(java.lang.String display)

Overrides:

withDisplay in class ValuedFeature

withLevel

public NumericalFeature withLevel(java.lang.String level)

Overrides:

withLevel in class ValuedFeature

setStep

public void setStep(int step)

the optional step used

getStep

public int getStep()

the optional step used

withStep

public NumericalFeature withStep(int step)

withStep

public NumericalFeature withStep(java.lang.Integer step)

setMin

public void setMin(int min)

the minimum value of the extracted feature

getMin

public int getMin()

the minimum value of the extracted feature

withMin

public NumericalFeature withMin(int min)

withMin

public NumericalFeature withMin(java.lang.Integer min)

setMax

public void setMax(int max)

the maximum value of the extracted feature

getMax

public int getMax()

the maximum value of the extracted feature

withMax

public NumericalFeature withMax(int max)

withMax

public NumericalFeature withMax(java.lang.Integer max)

setCoefficient

public void setCoefficient(double coefficient)

the coefficient used to multiply the extracted feature

getCoefficient

public double getCoefficient()

the coefficient used to multiply the extracted feature

withCoefficient

public NumericalFeature withCoefficient(double coefficient)

setPrecision

public void setPrecision(int precision)

the floating point precision in the display form

getPrecision

public int getPrecision()

the floating point precision in the display form

withPrecision

public NumericalFeature withPrecision(int precision)

withPrecision

public NumericalFeature withPrecision(java.lang.Integer precision)

setHandleOutOfBoundValues

public void setHandleOutOfBoundValues(boolean handleOutOfBoundValues)

handle the value that are out of bound

isHandleOutOfBoundValues

public boolean isHandleOutOfBoundValues()

handle the value that are out of bound

withHandleOutOfBoundValues

public NumericalFeature withHandleOutOfBoundValues(boolean handleOutOfBoundValues)

withHandleOutOfBoundValues

public NumericalFeature withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)

setAddExactValue

public void setAddExactValue(boolean addExactValue)

add the value (without any normalization) in a second annotation named TAG.exact

isAddExactValue

public boolean isAddExactValue()

add the value (without any normalization) in a second annotation named TAG.exact

withAddExactValue

public NumericalFeature withAddExactValue(boolean addExactValue)

withAddExactValue

public NumericalFeature withAddExactValue(java.lang.Boolean addExactValue)

setTruncateTrailingZeros

public void setTruncateTrailingZeros(boolean truncateTrailingZeros)

remove the trailing zeros after comma

isTruncateTrailingZeros

public boolean isTruncateTrailingZeros()

remove the trailing zeros after comma

withTruncateTrailingZeros

public NumericalFeature withTruncateTrailingZeros(boolean truncateTrailingZeros)

withTruncateTrailingZeros

public NumericalFeature withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)

makeCopy

public NumericalFeature makeCopy()

Creates and returns a deep copy of this NumericalFeature.

Overrides:

makeCopy in class ValuedFeature

readFrom

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

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

Overrides:

writeTo in class ValuedFeature

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NumericalFeature.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NumericalFeature.

Overrides:

toString in class ValuedFeature

check

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

Checks this NumericalFeature.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValuedFeature

Throws:

com.exalead.util.TypedException