JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart3d.data
Class Base3dDataSource

java.lang.Object
  |
  +--com.klg.jclass.chart3d.event.Chart3dDataSupport
        |
        +--com.klg.jclass.chart3d.data.Base3dDataSource
All Implemented Interfaces:
Chart3dDataManager, Chart3dDataModel, HoleValueChart3dDataModel, Serializable
Direct Known Subclasses:
Base3dGridDataSource, Base3dPointDataSource

public abstract class Base3dDataSource
extends Chart3dDataSupport
implements Chart3dDataModel, HoleValueChart3dDataModel

Empty base class which implements the DataModel's common ancestor. Do not attempt to instantiate.

See Also:
Serialized Form

Field Summary
protected  double holeValue
          Hole Value property for positions that are not to be plotted.
 
Fields inherited from class com.klg.jclass.chart3d.event.Chart3dDataSupport
source
 
Fields inherited from interface com.klg.jclass.chart3d.HoleValueChart3dDataModel
DEFAULT_HOLE_VALUE
 
Constructor Summary
Base3dDataSource()
          The default constructor for a Chart3dDataSupport object.
Base3dDataSource(Object dataSrc)
          Constructor used to create a Base3dDataSource object with a given data source.
 
Method Summary
 double getHoleValue()
          Returns the hole value for the chart 3D data.
 void setHoleValue(double holeValue)
          Sets the hole value for the chart 3D data.
 
Methods inherited from class com.klg.jclass.chart3d.event.Chart3dDataSupport
addChart3dDataListener, fireChart3dDataEvent, fireChart3dDataEvent, removeChart3dDataListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

holeValue

protected double holeValue
Hole Value property for positions that are not to be plotted. Defaults to HoleValueChart3dDataModel.DEFAULT_HOLE_VALUE.

Constructor Detail

Base3dDataSource

public Base3dDataSource()
The default constructor for a Chart3dDataSupport object.


Base3dDataSource

public Base3dDataSource(Object dataSrc)
Constructor used to create a Base3dDataSource object with a given data source.

Parameters:
dataSrc - the data source
Method Detail

getHoleValue

public double getHoleValue()
Returns the hole value for the chart 3D data. The hole value is a floating point number used to represent a hole in the data. Internally, this value is placed in the arrays to represent a missing data value. If the hole value is not explicitly set, returns HoleValueChart3dDataModel.DEFAULT_HOLE_VALUE by default.

Specified by:
getHoleValue in interface HoleValueChart3dDataModel
Returns:
floating-point value used as a placeholder for missing values

setHoleValue

public void setHoleValue(double holeValue)
Sets the hole value for the chart 3D data. The hole value is a floating point number used to represent a hole in the data. Internally, this value is placed in the arrays to represent a missing data value. The hole value should not be set to Double.NAN.

If the hole value is changed, previously designated hole values will be drawn at their actual set value (that is, the old hole value). If this old hole value is the default hole value as defined by HoleValueChart3dDataModel.DEFAULT_HOLE_VALUE, chart 3D will experience severe drawing slowness due to trying to scale its values to such a great range. If you are using this method to change hole values, it is suggested that you first change the previous hole values inside the data to something realistic or to the new hole value you are about to set.

Parameters:
holeValue - floating-point value used as a placeholder for missing values

Copyright © 2004 Quest Software Inc..
All rights reserved.