gov.noaa.pmel.sgt.dm
Class Collection

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--java.util.Vector
                    |
                    +--gov.noaa.pmel.sgt.dm.Collection
All Implemented Interfaces:
java.lang.Cloneable, java.util.Collection, java.util.List, java.io.Serializable, SGTData
Direct Known Subclasses:
PointCollection

public class Collection
extends java.util.Vector
implements SGTData, java.lang.Cloneable

Collection is an extension to Vector designed to hold SGTData objects. These objects must have consistent x and y coordinate types. Otherwise, the isXTime(), isYTime(), getXMetaData(), getYMetaData(), and get?Ranges() methods will fail.

Since:
1.0
Version:
$Revision: 1.8 $, $Date: 2001/10/10 19:05:01 $
Author:
Donald Denbo
See Also:
SGTData, SGTPoint, SGTLine, SGTGrid, SGTVector, Serialized Form

Constructor Summary
Collection()
           
Collection(java.lang.String title)
           
Collection(java.lang.String title, int initialCapacity)
           
Collection(java.lang.String title, int initialCapacity, int increment)
           
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener l)
          Add a PropertyChangeListener to the listener list.
 SGTData copy()
          Create a 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.
 void setId(java.lang.String ident)
          Set the unique identifier.
 void setKeyTitle(SGLabel title)
           
 void setTitle(java.lang.String title)
          Set the title.
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Constructor Detail

Collection

public Collection()

Collection

public Collection(java.lang.String title)

Collection

public Collection(java.lang.String title,
                  int initialCapacity)

Collection

public Collection(java.lang.String title,
                  int initialCapacity,
                  int increment)
Method Detail

copy

public SGTData copy()
Create a copy.
Specified by:
copy in interface SGTData
See Also:
SGTData

getTitle

public java.lang.String getTitle()
Get the title.
Specified by:
getTitle in interface SGTData

setTitle

public void setTitle(java.lang.String title)
Set the title.

getKeyTitle

public SGLabel getKeyTitle()
Description copied from interface: SGTData
Get a title formatted for a Key. JPlotLayout will use this if an explicit Key title is not given in the addData method.
Specified by:
getKeyTitle in interface SGTData
Following copied from interface: gov.noaa.pmel.sgt.dm.SGTData
See Also:
SGLabel, ColorKey, LineKey, PointCollectionKey, VectorKey

setKeyTitle

public void setKeyTitle(SGLabel title)

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.
Specified by:
getId in interface SGTData
Returns:
unique identifier
See Also:
Pane, Layer

setId

public void setId(java.lang.String ident)
Set the unique identifier.

isXTime

public boolean isXTime()
Description copied from interface: SGTData
Returns true if the X coordinate is Time.
Specified by:
isXTime in interface SGTData

isYTime

public boolean isYTime()
Description copied from interface: SGTData
Returns true if the Y coordinate is Time.
Specified by:
isYTime in interface SGTData

getXMetaData

public SGTMetaData getXMetaData()
Description copied from interface: SGTData
Returns the X SGTMetaData.
Specified by:
getXMetaData in interface SGTData

getYMetaData

public SGTMetaData getYMetaData()
Description copied from interface: SGTData
Returns the Y SGTMetaData.
Specified by:
getYMetaData in interface SGTData

getXRange

public SoTRange getXRange()
Description copied from interface: SGTData
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.
Specified by:
getXRange in interface SGTData
Following copied from interface: gov.noaa.pmel.sgt.dm.SGTData
See Also:
GeoDate.isMissing()

getYRange

public SoTRange getYRange()
Description copied from interface: SGTData
Returns the range of the Y coordinates.
Specified by:
getYRange in interface SGTData
Following copied from interface: gov.noaa.pmel.sgt.dm.SGTData
See Also:
SGTData.getXRange()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
Description copied from interface: SGTData
Add a PropertyChangeListener to the listener list.
Specified by:
addPropertyChangeListener in interface SGTData

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
Description copied from interface: SGTData
Remove a PropertyChangeListener from the listener list.
Specified by:
removePropertyChangeListener in interface SGTData


Send comments about the Scientific Graphics toolkit to dwd@pmel.noaa.gov. For more information about Java Development in the EPIC Group see the EPIC Software Page
Generated on December 13 2001