gov.sandia.cognition.evaluator
Class ValueClamper<DataType extends Comparable<DataType>>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.evaluator.ValueClamper<DataType>
Type Parameters:
DataType - The type to clamp.
All Implemented Interfaces:
Evaluator<DataType,DataType>, CloneableSerializable, Serializable, Cloneable

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-12-02",
            changesNeeded=false,
            comments="Looks good... very clever and clear implementation.")
public class ValueClamper<DataType extends Comparable<DataType>>
extends AbstractCloneableSerializable
implements Evaluator<DataType,DataType>, Serializable

An evaluator that clamps a number between minimum and maximum values. It can be used as a one-sided clamper by having the other value set to null or as a two-sided clamper by setting both the minimum and maximum values.

Since:
3.0
Author:
Justin Basilico
See Also:
Serialized Form

Constructor Summary
ValueClamper()
          Creates a new ValueClamper.
ValueClamper(DataType minimum, DataType maximum)
          Creates a new ValueClamper with the given minimum and maximum values.
 
Method Summary
 ValueClamper<DataType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 DataType evaluate(DataType input)
          Evaluates the function on the given input and returns the output.
 DataType getMaximum()
          Gets the maximum value to allow.
 DataType getMinimum()
          Gets the minimum value to allow.
 void setMaximum(DataType maximum)
          Sets the maximum value to allow.
 void setMinimum(DataType minimum)
          Gets the minimum value to allow.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueClamper

public ValueClamper()
Creates a new ValueClamper. The minimum and maximum are initialized to null.


ValueClamper

public ValueClamper(DataType minimum,
                    DataType maximum)
Creates a new ValueClamper with the given minimum and maximum values.

Parameters:
minimum - The minimum value.
maximum - The maximum value.
Method Detail

clone

public ValueClamper<DataType> clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

evaluate

public DataType evaluate(DataType input)
Description copied from interface: Evaluator
Evaluates the function on the given input and returns the output.

Specified by:
evaluate in interface Evaluator<DataType extends Comparable<DataType>,DataType extends Comparable<DataType>>
Parameters:
input - The input to evaluate.
Returns:
The output produced by evaluating the input.

getMinimum

public DataType getMinimum()
Gets the minimum value to allow. May be null to not enforce a minimum.

Returns:
The minimum value to allow.

setMinimum

public void setMinimum(DataType minimum)
Gets the minimum value to allow. May be null to not enforce a minimum.

Parameters:
minimum - The minimum value to allow.

getMaximum

public DataType getMaximum()
Gets the maximum value to allow. May be null to not enforce a maximum.

Returns:
The maximum value to allow.

setMaximum

public void setMaximum(DataType maximum)
Sets the maximum value to allow. May be null to not enforce a maximum.

Parameters:
maximum - The maximum value to allow.