oracle.dss.sparkChart

Class Threshold

java.lang.Object

oracle.dss.sparkChart.Threshold

public final class Threshold
extends java.lang.Object

Defines methods for specifying thresholds for formatting data items on a spark chart.

Since:

release specific (what release of product did this appear in)

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor(int index) Returns the Color used to format data items that fall within the threshold.
double	getMaxValue(int index) Returns the upper bound of the threshold.
void	setColor(int index, java.awt.Color color) Specifies the Color used to format data items that fall within the threshold.
void	setMaxValue(int index, double maxValue) Specifies the upper bound of the threshold.

Methods inherited from class java.lang.Object

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

Method Detail

setColor

public void setColor(int index,
            java.awt.Color color)
              throws ThresholdOutOfRangeException

Specifies the Color used to format data items that fall within the threshold.

Parameters:

index - the index of the threshold

color - the Color of the threshold

Throws:

ThresholdOutOfRangeException

getColor

public java.awt.Color getColor(int index)
                        throws ThresholdOutOfRangeException

Returns the Color used to format data items that fall within the threshold.

Parameters:

index - the index of the threshold

Returns:

the Color of the threshold

Throws:

ThresholdOutOfRangeException

setMaxValue

public void setMaxValue(int index,
               double maxValue)
                 throws ThresholdOutOfRangeException

Specifies the upper bound of the threshold.

Parameters:

index - the index of the threshold

maxValue - the upper bound of this threshold

Throws:

ThresholdOutOfRangeException

getMaxValue

public double getMaxValue(int index)
                   throws ThresholdOutOfRangeException

Returns the upper bound of the threshold.

Parameters:

index - the index of the threshold

Returns:

the upper bound of this threshold

Throws:

ThresholdOutOfRangeException