com.exalead.mot.components.featuresextractor

Class FloatingPointFeature

java.lang.Object

com.exalead.mot.components.featuresextractor.Feature

com.exalead.mot.components.featuresextractor.ValuedFeature

com.exalead.mot.components.featuresextractor.FloatingPointFeature

All Implemented Interfaces:

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

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

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 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.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
FloatingPointFeature()
FloatingPointFeature(FloatingPointFeature o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FloatingPointFeature.
static FloatingPointFeature	fromString(java.lang.String s) String representation of this FloatingPointFeature.
double	getCoefficient() the coefficient used to multiply the extracted feature
double	getMax() the maximum value of the extracted feature
double	getMin() the minimum value of the extracted feature
int	getPrecision() the floating point precision in the display form
double	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
FloatingPointFeature	makeCopy() Creates and returns a deep copy of this FloatingPointFeature.
static FloatingPointFeature	readFrom(java.io.InputStream is) Read this FloatingPointFeature 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(double max) the maximum value of the extracted feature
void	setMin(double min) the minimum value of the extracted feature
void	setPrecision(int precision) the floating point precision in the display form
void	setStep(double step) the optional step used
void	setTruncateTrailingZeros(boolean truncateTrailingZeros) remove the trailing zeros after comma
java.lang.String	toString() String representation of this FloatingPointFeature.
FloatingPointFeature	withAddExactValue(boolean addExactValue)
FloatingPointFeature	withAddExactValue(java.lang.Boolean addExactValue)
FloatingPointFeature	withAnnotation(java.lang.String annotation)
FloatingPointFeature	withCoefficient(double coefficient)
FloatingPointFeature	withDisplay(java.lang.String display)
FloatingPointFeature	withHandleOutOfBoundValues(boolean handleOutOfBoundValues)
FloatingPointFeature	withHandleOutOfBoundValues(java.lang.Boolean handleOutOfBoundValues)
FloatingPointFeature	withLevel(java.lang.String level)
FloatingPointFeature	withMax(double max)
FloatingPointFeature	withMin(double min)
FloatingPointFeature	withPrecision(int precision)
FloatingPointFeature	withPrecision(java.lang.Integer precision)
FloatingPointFeature	withStep(double step)
FloatingPointFeature	withTrigger(java.lang.String trigger)
FloatingPointFeature	withTriggers(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointFeature	withTriggers(exa.bee.StringValue... __values)
FloatingPointFeature	withTruncateTrailingZeros(boolean truncateTrailingZeros)
FloatingPointFeature	withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)
FloatingPointFeature	withUnit(java.lang.String unit)
FloatingPointFeature	withUnits(java.util.Collection<exa.bee.StringValue> __values)
FloatingPointFeature	withUnits(exa.bee.StringValue... __values)
void	writeTo(java.io.OutputStream os) Write this FloatingPointFeature 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 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

FloatingPointFeature

public FloatingPointFeature()

FloatingPointFeature

public FloatingPointFeature(FloatingPointFeature o)

Copy constructor

Method Detail

withUnit

public FloatingPointFeature withUnit(java.lang.String unit)

Overrides:

withUnit in class ValuedFeature

withUnits

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

Overrides:

withUnits in class ValuedFeature

withUnits

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

Overrides:

withUnits in class ValuedFeature

withTrigger

public FloatingPointFeature withTrigger(java.lang.String trigger)

Overrides:

withTrigger in class ValuedFeature

withTriggers

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

Overrides:

withTriggers in class ValuedFeature

withTriggers

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

Overrides:

withTriggers in class ValuedFeature

withAnnotation

public FloatingPointFeature withAnnotation(java.lang.String annotation)

Overrides:

withAnnotation in class ValuedFeature

withDisplay

public FloatingPointFeature withDisplay(java.lang.String display)

Overrides:

withDisplay in class ValuedFeature

withLevel

public FloatingPointFeature withLevel(java.lang.String level)

Overrides:

withLevel in class ValuedFeature

setStep

public void setStep(double step)

the optional step used

getStep

public double getStep()

the optional step used

withStep

public FloatingPointFeature withStep(double step)

setMin

public void setMin(double min)

the minimum value of the extracted feature

getMin

public double getMin()

the minimum value of the extracted feature

withMin

public FloatingPointFeature withMin(double min)

setMax

public void setMax(double max)

the maximum value of the extracted feature

getMax

public double getMax()

the maximum value of the extracted feature

withMax

public FloatingPointFeature withMax(double 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 FloatingPointFeature 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 FloatingPointFeature withPrecision(int precision)

withPrecision

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

withHandleOutOfBoundValues

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

withAddExactValue

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

withTruncateTrailingZeros

public FloatingPointFeature withTruncateTrailingZeros(java.lang.Boolean truncateTrailingZeros)

makeCopy

public FloatingPointFeature makeCopy()

Creates and returns a deep copy of this FloatingPointFeature.

Overrides:

makeCopy in class ValuedFeature

readFrom

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

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

Overrides:

writeTo in class ValuedFeature

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FloatingPointFeature.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FloatingPointFeature.

Overrides:

toString in class ValuedFeature

check

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

Checks this FloatingPointFeature.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValuedFeature

Throws:

com.exalead.util.TypedException