IBaseTemporalObject (DMLab Library API for 0.0.4-SNAPSHOT)

All Known Subinterfaces:

ISpatialTemporalObj, ISpatialTemporalTrajectory<T>, ISTInterpolationEvent, ISTInterpolationTrajectory, ISTTrackingEvent, ISTTrackingTrajectory

All Known Implementing Classes:

BaseTemporalObject, GeneralSTInterpolationEvent, GeneralSTInterpolationTrajectory, GeneralSTObject, GeneralSTTrackingEvent, GeneralSTTrackingTrajectory
```
public interface IBaseTemporalObject
```
Is the base data type for Events and Tracks in the tracking module, as well as any spatio-temporal objects used in the solgrind module or interpolation module. This simply so we can perform temporal indexing with the same index object.

Author:

Dustin Kempton, Data Mining Lab, Georgia State University

Field Summary

Fields
Modifier and Type Field Description

static Comparator<IBaseTemporalObject> baseTemporalComparator
The temporal comparator for the IBaseDataType

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`compareTime(IBaseTemporalObject baseDataType)`	Compares the valid time of another IBaseDataType to this object's valid time.
`org.joda.time.Interval`	`getTimePeriod()`	Returns the time period that the object is valid for
`UUID`	`getUUID()`	Returns a unique identifier for this object inside this program.

- Field Detail
  - baseTemporalComparator
```
static final Comparator<IBaseTemporalObject> baseTemporalComparator
```
    The temporal comparator for the IBaseDataType
- Method Detail
  - getTimePeriod
```
org.joda.time.Interval getTimePeriod()
```
    Returns the time period that the object is valid for
    
    Returns:
    
    The interval over which the data type is valid.
  - compareTime
```
int compareTime(IBaseTemporalObject baseDataType)
```
    Compares the valid time of another IBaseDataType to this object's valid time.
    
    Parameters:
    
    baseDataType - The object to compare against this object.
    
    Returns:
    
    a negative integer, zero, or a positive integer as the passed in object is less than, equal to, or greater than this object.
  - getUUID
```
UUID getUUID()
```
    Returns a unique identifier for this object inside this program. This was added for use in caching because different event types may contain identifiers in the ID that overlap from one event type to the next. This is so we can uniquely identify this particular object when caching such things as image parameters.
    
    Returns:
    
    A unique identifier for this object inside this program.