gov.sandia.cognition.data.convert.number

Class DefaultBooleanToNumberConverter

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.data.convert.AbstractDataConverter<InputType,OutputType>

gov.sandia.cognition.data.convert.AbstractReversibleDataConverter<InputType,OutputType>

gov.sandia.cognition.data.convert.AbstractReverseCachedDataConverter<java.lang.Boolean,java.lang.Number,DefaultBooleanToNumberConverter.Reverse>

gov.sandia.cognition.data.convert.number.DefaultBooleanToNumberConverter

All Implemented Interfaces:

DataConverter<java.lang.Boolean,java.lang.Number>, ReversibleDataConverter<java.lang.Boolean,java.lang.Number>, Evaluator<java.lang.Boolean,java.lang.Number>, ReversibleEvaluator<java.lang.Boolean,java.lang.Number,DataConverter<? super java.lang.Number,? extends java.lang.Boolean>>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class DefaultBooleanToNumberConverter
extends AbstractReverseCachedDataConverter<java.lang.Boolean,java.lang.Number,DefaultBooleanToNumberConverter.Reverse>

Converts a Boolean to a Number by using predefined values for true, false, and (optionally) null.

Since:

3.0

Author:

Justin Basilico

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultBooleanToNumberConverter.Reverse The reverse converter for the DefaultBooleanToNumberConverter.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_FALSE_VALUE The default value for false is -1.0.
static double	DEFAULT_NULL_VALUE The default value for null is 0.0.
static double	DEFAULT_TRUE_VALUE The default value for true is 1.0.
protected java.lang.Number	falseValue The number to use to represent a false value.
protected java.lang.Number	nullValue The number to use to represent a null value.
protected java.lang.Number	trueValue The number to use to represent a true value.

Fields inherited from class gov.sandia.cognition.data.convert.AbstractReverseCachedDataConverter

reverse

Constructor Summary

Constructors

Constructor and Description
DefaultBooleanToNumberConverter() Creates a new DefaultBooleanToNumberConverter with default values.
DefaultBooleanToNumberConverter(java.lang.Number trueValue, java.lang.Number falseValue, java.lang.Number nullValue) Creates a new DefaultBooleanToNumberConverter.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	convertToBoolean(java.lang.Number input) Converts the given number to a boolean value by determining if it is closer to the number representing true or the number representing false.
java.lang.Number	convertToNumber(java.lang.Boolean input) Converts the given boolean to a number using the
protected DefaultBooleanToNumberConverter.Reverse	createReverse() Creates a new reverse converter.
java.lang.Number	evaluate(java.lang.Boolean input) Converts an input boolean to a number.
java.lang.Number	getFalseValue() Gets the number that represents a falue value.
java.lang.Number	getNullValue() Gets the number that represents a null value.
java.lang.Number	getTrueValue() Gets the number that represents a true value.
void	setFalseValue(java.lang.Number falseValue) Sets the number that represents a falue value.
void	setNullValue(java.lang.Number nullValue) Sets the number that represents a null value.
void	setTrueValue(java.lang.Number trueValue) Sets the number that represents a true value.

Methods inherited from class gov.sandia.cognition.data.convert.AbstractReverseCachedDataConverter

reverse

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TRUE_VALUE

public static final double DEFAULT_TRUE_VALUE

The default value for true is 1.0.

See Also:

Constant Field Values

DEFAULT_FALSE_VALUE

public static final double DEFAULT_FALSE_VALUE

The default value for false is -1.0.

See Also:

Constant Field Values

DEFAULT_NULL_VALUE

public static final double DEFAULT_NULL_VALUE

The default value for null is 0.0.

See Also:

Constant Field Values

trueValue

protected java.lang.Number trueValue

The number to use to represent a true value.

falseValue

protected java.lang.Number falseValue

The number to use to represent a false value.

nullValue

protected java.lang.Number nullValue

The number to use to represent a null value.

Constructor Detail

DefaultBooleanToNumberConverter

public DefaultBooleanToNumberConverter()

Creates a new DefaultBooleanToNumberConverter with default values.

DefaultBooleanToNumberConverter

public DefaultBooleanToNumberConverter(java.lang.Number trueValue,
                                       java.lang.Number falseValue,
                                       java.lang.Number nullValue)

Creates a new DefaultBooleanToNumberConverter.

Parameters:

trueValue - The number to use for true.

falseValue - The number to use for false.

nullValue - The number to use for null.

Method Detail

evaluate

public java.lang.Number evaluate(java.lang.Boolean input)

Converts an input boolean to a number.

Parameters:

input - The input value to convert.

Returns:

The boolean converted to a number.

convertToNumber

public java.lang.Number convertToNumber(java.lang.Boolean input)

Converts the given boolean to a number using the

Parameters:

input - The input boolean to convert to a number.

Returns:

The number value for the boolean.

convertToBoolean

public java.lang.Boolean convertToBoolean(java.lang.Number input)

Converts the given number to a boolean value by determining if it is closer to the number representing true or the number representing false.

Parameters:

input - The input number to convert to a boolean.

Returns:

The boolean value of the number.

createReverse

protected DefaultBooleanToNumberConverter.Reverse createReverse()

Description copied from class: AbstractReverseCachedDataConverter

Creates a new reverse converter. Should only be called when there is a cache miss for this converter.

Specified by:

createReverse in class AbstractReverseCachedDataConverter<java.lang.Boolean,java.lang.Number,DefaultBooleanToNumberConverter.Reverse>

Returns:

The reverse converter.

getTrueValue

public java.lang.Number getTrueValue()

Gets the number that represents a true value.

Returns:

The number that represents a true value.

setTrueValue

public void setTrueValue(java.lang.Number trueValue)

Sets the number that represents a true value.

Parameters:

trueValue - The number that represents a true value.

getFalseValue

public java.lang.Number getFalseValue()

Gets the number that represents a falue value.

Returns:

The number that represents a false value.

setFalseValue

public void setFalseValue(java.lang.Number falseValue)

Sets the number that represents a falue value.

Parameters:

falseValue - The number that represents a false value.

getNullValue

public java.lang.Number getNullValue()

Gets the number that represents a null value.

Returns:

The number that represents a null value.

setNullValue

public void setNullValue(java.lang.Number nullValue)

Sets the number that represents a null value.

Parameters:

nullValue - The number that represents a null value.