com.klg.jclass.chart3d
Class JCData3dContourIndex

java.lang.Object
  |
  +--com.klg.jclass.chart3d.JCData3dIndex
        |
        +--com.klg.jclass.chart3d.JCData3dContourIndex

All Implemented Interfaces:

Serializable

public class JCData3dContourIndex

extends JCData3dIndex

implements Serializable

JCData3dContourIndex contains a unique index to a contour level style and the minimum and maximum values of the range that it represents. It is used by the chart's pick() methods, and also contains information related to these operations.

See Also:

Serialized Form

Field Summary

protected int	contourStyleIndex The index of the contour style selected.
protected double	lowerContourRangeValue The lower value of the range for the selected contour.
protected double	upperContourRangeValue The upper value of the range for the selected contour.

Fields inherited from class com.klg.jclass.chart3d.JCData3dIndex

ALL, dataView, distance, obj, parent

Constructor Summary

JCData3dContourIndex()
Simple constructor for JCData3dContourIndex.

JCData3dContourIndex(com.klg.jclass.chart3d.Chart3dDataView dataView)
Constructor that creates a data index from a data view, leaving other values to their default, undefined values.

JCData3dContourIndex(com.klg.jclass.chart3d.Chart3dDataView dataView, int styleIndex, double lowerVal, double upperVal)
Constructor that creates a data index from a data view, an index to a contour level style, and the minimum and maximum values of the range that the style specifies.

Method Summary

boolean	equals(Object o) Determines if the specified object refers to the same data point as this JCData3dContourIndex instance.
int	getContourStyleIndex() Gets the value of the ContourStyleIndex property.
double	getLowerContourRangeValue() Gets the value of the LowerContourRangeValue property.
double	getUpperContourRangeValue() Gets the value of the UpperContourRangeValue property.
void	setContourStyleIndex(int index) Sets the value of the ContourStyleIndex property.
void	setLowerContourRangeValue(double value) Sets the value of the LowerContourRangeValue property.
void	setUpperContourRangeValue(double value) Sets the value of the UpperContourRangeValue property.

Methods inherited from class com.klg.jclass.chart3d.JCData3dIndex

getDataView, getDistance, getObject, setChanged, setDataView, setDistance, setObject

Methods inherited from class java.lang.Object

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

Field Detail

contourStyleIndex

protected int contourStyleIndex

The index of the contour style selected.

lowerContourRangeValue

protected double lowerContourRangeValue

The lower value of the range for the selected contour.

upperContourRangeValue

protected double upperContourRangeValue

The upper value of the range for the selected contour.

Constructor Detail

JCData3dContourIndex

public JCData3dContourIndex()

Simple constructor for JCData3dContourIndex.

JCData3dContourIndex

public JCData3dContourIndex(com.klg.jclass.chart3d.Chart3dDataView dataView)

Constructor that creates a data index from a data view, leaving other values to their default, undefined values.

Parameters:

dataView - the data view represented by this class

JCData3dContourIndex

public JCData3dContourIndex(com.klg.jclass.chart3d.Chart3dDataView dataView,
                            int styleIndex,
                            double lowerVal,
                            double upperVal)

Constructor that creates a data index from a data view, an index to a contour level style, and the minimum and maximum values of the range that the style specifies. If the contour range values are equal, then specific contour level is being referenced as opposed to a range.

Parameters:

dataView - the data view that holds the contour indices

styleIndex - the index of the contour style that is used to illustrate this range or contour

lowerVal - The lower value of the contour range. If equal to upperVal, this object refers to a specific contour rather than a range.

upperVal - The higher value of the contour range. If equal to upperVal, this object refers to a specific contour rather than a range.

Method Detail

getContourStyleIndex

public int getContourStyleIndex()

Gets the value of the ContourStyleIndex property. It contains the index to the contour style used to illustrate the contour range specified by this object. If negative, then no contour style is associated with this range.

Returns:

the index of the contour style used to illustrate this contour range

setContourStyleIndex

public void setContourStyleIndex(int index)

Sets the value of the ContourStyleIndex property. It refers the index to the contour style used to illustrate the contour range specified by this object. If negative, then no contour style is associated with this range.

Parameters:

index - the index of the contour style used to illustrate this contour range

getUpperContourRangeValue

public double getUpperContourRangeValue()

Gets the value of the UpperContourRangeValue property. It contains the upper value of the contour range specified by this object. If this property is equal to LowerContourRangeValue, then this object refers not to a contour range but to a single contour level.

Returns:

the upper value of the contour range

setUpperContourRangeValue

public void setUpperContourRangeValue(double value)

Sets the value of the UpperContourRangeValue property. This sets the upper value of the contour range specified by this object. If this property is equal to LowerContourRangeValue, then this object refers not to a contour range but to a single contour level.

Parameters:

value - the upper value of the contour range

getLowerContourRangeValue

public double getLowerContourRangeValue()

Gets the value of the LowerContourRangeValue property. It contains the upper value of the contour range specified by this object. If this property is equal to UpperContourRangeValue, then this object refers not to a contour range but to a single contour level.

Returns:

the upper value of the contour range

setLowerContourRangeValue

public void setLowerContourRangeValue(double value)

Sets the value of the LowerContourRangeValue property. This sets the upper value of the contour range specified by this object. If this property is equal to UpperContourRangeValue, then this object refers not to a contour range but to a single contour level.

Parameters:

value - the upper value of the contour range

equals

public boolean equals(Object o)

Determines if the specified object refers to the same data point as this JCData3dContourIndex instance.

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

if the passed object is a JCData3dContourIndex instance and refers to the same data point as this instance