org.pepstock.charba.client.enums

Class Threshold

java.lang.Object

org.pepstock.charba.client.enums.Threshold

All Implemented Interfaces:

IsThreshold

public final class Threshold
extends java.lang.Object
implements IsThreshold

Is the threshold to use for gauge chart.

Author:

Andrea "Stock" Stocchero

See Also:

GaugeDataset.setThresholds(Threshold...)

Field Summary

Fields

Modifier and Type	Field and Description
static IsColor	DEFAULT_VALUE_COLOR Default color value.

Constructor Summary

Constructors

Constructor and Description
Threshold(java.lang.String name) Creates a threshold with standard color (DEFAULT_VALUE_COLOR) and value (Double.MAX_VALUE).
Threshold(java.lang.String name, double value) Creates a threshold with standard color (DEFAULT_VALUE_COLOR).
Threshold(java.lang.String name, double value, IsColor color) Creates a threshold
Threshold(java.lang.String name, IsColor color) Creates a threshold with standard value (Double.MAX_VALUE).

Method Summary

Modifier and Type	Method and Description
IsColor	getColor() Returns the color of threshold.
java.lang.String	getName() Returns the name of threshold.
double	getValue() Returns the value of threshold.
boolean	isInRange(double valueToCheck, double lowLimit) Checks if the value passed is into threshold.
Threshold	setColor(IsColor color)
Threshold	setValue(double value)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VALUE_COLOR

public static final IsColor DEFAULT_VALUE_COLOR

Default color value.

See Also:

GaugeThreshold.normal

Constructor Detail

Threshold

public Threshold(java.lang.String name)

Creates a threshold with standard color (DEFAULT_VALUE_COLOR) and value (Double.MAX_VALUE).

Parameters:

name - name of threshold

Threshold

public Threshold(java.lang.String name,
                 IsColor color)

Creates a threshold with standard value (Double.MAX_VALUE).

Parameters:

name - name of threshold

color - color of threshold

Threshold

public Threshold(java.lang.String name,
                 double value)

Creates a threshold with standard color (DEFAULT_VALUE_COLOR).

Parameters:

name - name of threshold

value - value of threshold

Threshold

public Threshold(java.lang.String name,
                 double value,
                 IsColor color)

Creates a threshold

Parameters:

name - name of threshold

value - value of threshold

color - color of threshold

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IsThreshold

Returns the name of threshold.

Specified by:

getName in interface IsThreshold

Returns:

the name of threshold.

getValue

public double getValue()

Description copied from interface: IsThreshold

Returns the value of threshold.

Specified by:

getValue in interface IsThreshold

Returns:

the value of threshold.

getColor

public IsColor getColor()

Description copied from interface: IsThreshold

Returns the color of threshold.

Specified by:

getColor in interface IsThreshold

Returns:

the color of threshold.

setValue

public Threshold setValue(double value)

Parameters:

value - the value to set

Returns:

the threshold instance

setColor

public Threshold setColor(IsColor color)

Parameters:

color - the color to set

Returns:

the threshold instance

isInRange

public boolean isInRange(double valueToCheck,
                         double lowLimit)

Checks if the value passed is into threshold.

Parameters:

valueToCheck - value to check

lowLimit - the low limit

Returns:

true is the value is inside the range, otherwise false.