gov.noaa.pmel.util
Class SoTRange

java.lang.Object
  extended by gov.noaa.pmel.util.SoTRange
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
SoTRange.Double, SoTRange.Float, SoTRange.GeoDate, SoTRange.Integer, SoTRange.Short, SoTRange.Time

public abstract class SoTRange
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

SoTRange is an abstract class used to wrap either a double or GeoDate. SoT stands for space or time, but being basically lazy I've abbreviated it. Contains minimum, maximum, and delta SoTRange. The SoTRange object represents the range of all missing data as Double.NaN as the start and end values for data of type Double and return GeoDate(Long.MIN_VALUE) for data of type GeoDate.

Since:
sgt 2.0
Author:
Donald Denbo
See Also:
SGTData, Serialized Form

Nested Class Summary
static class SoTRange.Double
          Inner class for SoTRange for type double.
static class SoTRange.Float
          Inner class for SoTRange for type flaot.
static class SoTRange.GeoDate
          Deprecated. As of sgt 3.0, replaced by SoTRange.Time
static class SoTRange.Integer
          Inner class for SoTRange for type integer.
static class SoTRange.Short
          Inner class for SoTRange for type short.
static class SoTRange.Time
          Inner class for SoTRange for type long.
 
Constructor Summary
protected SoTRange()
          This is an abstract class that cannot be instantiated directly.
 
Method Summary
abstract  void add(SoTRange range)
           
abstract  SoTRange copy()
           
abstract  boolean equals(SoTRange range)
           
abstract  void flipStartAndEnd()
           
abstract  SoTValue getDelta()
           
abstract  java.lang.Object getDeltaObject()
           
abstract  SoTValue getEnd()
           
abstract  java.lang.Object getEndObject()
           
abstract  SoTValue getStart()
           
abstract  java.lang.Object getStartObject()
           
abstract  boolean isStartOrEndMissing()
           
abstract  boolean isTime()
           
abstract  void setDelta(SoTValue value)
           
abstract  void setEnd(SoTValue value)
           
abstract  void setStart(SoTValue value)
           
abstract  java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SoTRange

protected SoTRange()
This is an abstract class that cannot be instantiated directly. Type-specific implementation subclasses are available for instantiation and provide a number of formats for storing the information necessary to satisfy the various accessor methods below.

Method Detail

isTime

public abstract boolean isTime()

toString

public abstract java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public abstract boolean equals(SoTRange range)

add

public abstract void add(SoTRange range)

getStart

public abstract SoTValue getStart()

getEnd

public abstract SoTValue getEnd()

getDelta

public abstract SoTValue getDelta()

getStartObject

public abstract java.lang.Object getStartObject()

getEndObject

public abstract java.lang.Object getEndObject()

getDeltaObject

public abstract java.lang.Object getDeltaObject()

setStart

public abstract void setStart(SoTValue value)

setEnd

public abstract void setEnd(SoTValue value)

setDelta

public abstract void setDelta(SoTValue value)

flipStartAndEnd

public abstract void flipStartAndEnd()

isStartOrEndMissing

public abstract boolean isStartOrEndMissing()

copy

public abstract SoTRange copy()