gov.noaa.pmel.sgt.dm
Interface SGTData

All Known Subinterfaces:

SGTGrid, SGTImage, SGTLine, SGTPoint

All Known Implementing Classes:

Collection, SGTVector

public interface SGTData

Base class for sgt datamodel rank information. The SGTData class and its children are used by sgt to determine the rank (point, line, grid) of the data. Data values can be either double or GeoDate, which extends Date. Missing values are indicated by Double.NaN for type double and by null or by Long.MIN_VALUE milliseconds after (before) January 1, 1970 00:00:00 GMT for GeoDate.

Since:

1.0

Version:

$Revision: 1.9 $, $Date: 2001/10/10 19:05:01 $

Author:

Donald Denbo

See Also:

SGTPoint, SGTLine, SGTGrid

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a PropertyChangeListener to the listener list.
SGTData	copy() Create a shallow copy.
java.lang.String	getId() Get the unique identifier.
SGLabel	getKeyTitle() Get a title formatted for a Key.
java.lang.String	getTitle() Get the title.
SGTMetaData	getXMetaData() Returns the X SGTMetaData.
SoTRange	getXRange() Returns the range of the X coordinates.
SGTMetaData	getYMetaData() Returns the Y SGTMetaData.
SoTRange	getYRange() Returns the range of the Y coordinates.
boolean	isXTime() Returns true if the X coordinate is Time.
boolean	isYTime() Returns true if the Y coordinate is Time.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Remove a PropertyChangeListener from the listener list.

Method Detail

getTitle

public java.lang.String getTitle()

Get the title.

getKeyTitle

public SGLabel getKeyTitle()

Get a title formatted for a Key. JPlotLayout will use this if an explicit Key title is not given in the addData method.

See Also:

SGLabel, ColorKey, LineKey, PointCollectionKey, VectorKey

getId

public java.lang.String getId()

Get the unique identifier. The presence of the identifier is optional, but if it is present it should be unique. This field is used to search for the layer that contains the data.

Returns:

unique identifier

See Also:

Pane, Layer

copy

public SGTData copy()

Create a shallow copy. User should implement using the clone() method, which requires the Cloneable interface be inherited. If clone() is used, then references to objects are copied NOT the object itself.

For example,

 public SGTData copy() {
   SGTData newData;
   try {
     newData = (SGTData)clone();
   } catch (CloneNotSupportedException e) {
     newData = null;
   }
   return newData;
 }
 

Returns:

shallow copy

See Also:

Object

isXTime

public boolean isXTime()

Returns true if the X coordinate is Time.

isYTime

public boolean isYTime()

Returns true if the Y coordinate is Time.

getXMetaData

public SGTMetaData getXMetaData()

Returns the X SGTMetaData.

getYMetaData

public SGTMetaData getYMetaData()

Returns the Y SGTMetaData.

getXRange

public SoTRange getXRange()

Returns the range of the X coordinates. If all the data in the array is missing, this method will return Double.NaN as the start and end values for data of type double and return GeoDate(Long.MIN_VALUE) for data of type GeoDate.

See Also:

GeoDate.isMissing()

getYRange

public SoTRange getYRange()

Returns the range of the Y coordinates.

See Also:

getXRange()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Add a PropertyChangeListener to the listener list.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Remove a PropertyChangeListener from the listener list.