org.jfree.data
Interface MeterDataset

All Superinterfaces:

Dataset, Value

All Known Implementing Classes:

DefaultMeterDataset

public interface MeterDataset

extends Value, Dataset

A dataset containing a single value within an overall range. In addition, the dataset defines three subranges: the 'normal' range, the 'warning' range and the 'critical' range.

This dataset can be used to supply data to meters and gauges. MeterPlot and ThermometerPlot are the current implementations.

Author:

Hari

Field Summary

static int	CRITICAL_DATA A constant representing the 'critical' level.
static int	FULL_DATA A constant representing the full data range.
static int	NORMAL_DATA A constant representing the 'normal' level.
static int	WARNING_DATA A constant representing the 'warning' level.

Method Summary

int	getBorderType() Returns the border type for the data.
java.lang.Number	getMaximumCriticalValue() Returns the upper value in the critical range.
java.lang.Number	getMaximumNormalValue() Returns the upper value in the normal range.
java.lang.Number	getMaximumValue() Returns the upper value in the overall range.
java.lang.Number	getMaximumWarningValue() Returns the upper value in the warning range.
java.lang.Number	getMinimumCriticalValue() Returns the lower value in the critical range.
java.lang.Number	getMinimumNormalValue() Returns the lower value in the normal range.
java.lang.Number	getMinimumValue() Returns the lower value in the overall range.
java.lang.Number	getMinimumWarningValue() Returns the lower value in the warning range.
java.lang.String	getUnits() Returns a string representing the units on the dial.
boolean	isValueValid() Returns true if the value is valid, and false otherwise.

Methods inherited from interface org.jfree.data.Value

getValue

Methods inherited from interface org.jfree.data.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Field Detail

NORMAL_DATA

public static final int NORMAL_DATA

A constant representing the 'normal' level.

See Also:

Constant Field Values

WARNING_DATA

public static final int WARNING_DATA

A constant representing the 'warning' level.

See Also:

Constant Field Values

CRITICAL_DATA

public static final int CRITICAL_DATA

A constant representing the 'critical' level.

See Also:

Constant Field Values

FULL_DATA

public static final int FULL_DATA

A constant representing the full data range.

See Also:

Constant Field Values

Method Detail

getMinimumValue

public java.lang.Number getMinimumValue()

Returns the lower value in the overall range.

Returns:

The lower value.

getMaximumValue

public java.lang.Number getMaximumValue()

Returns the upper value in the overall range.

Returns:

The upper value.

getMinimumNormalValue

public java.lang.Number getMinimumNormalValue()

Returns the lower value in the normal range.

Returns:

The lower value.

getMaximumNormalValue

public java.lang.Number getMaximumNormalValue()

Returns the upper value in the normal range.

Returns:

The upper value.

getMinimumWarningValue

public java.lang.Number getMinimumWarningValue()

Returns the lower value in the warning range.

Returns:

The lower value.

getMaximumWarningValue

public java.lang.Number getMaximumWarningValue()

Returns the upper value in the warning range.

Returns:

The upper value.

getMinimumCriticalValue

public java.lang.Number getMinimumCriticalValue()

Returns the lower value in the critical range.

Returns:

The lower value.

getMaximumCriticalValue

public java.lang.Number getMaximumCriticalValue()

Returns the upper value in the critical range.

Returns:

The upper value.

isValueValid

public boolean isValueValid()

Returns true if the value is valid, and false otherwise.

Returns:

boolean

getUnits

public java.lang.String getUnits()

Returns a string representing the units on the dial.

Returns:

the units.

getBorderType

public int getBorderType()

Returns the border type for the data.

Returns:

The border type.