ISTInterpolationEvent (DMLab Library API for 0.0.4-SNAPSHOT)

All Superinterfaces:

IBaseTemporalObject, ISpatialTemporalObj

All Known Implementing Classes:

GeneralSTInterpolationEvent
```
public interface ISTInterpolationEvent
extends ISpatialTemporalObj
```
Is the public interface for events processed by the interpolation algorithms implemented by the Data Mining Lab at Georgia State University.

Author:

Dustin Kempton, Data Mining Lab, Georgia State University

Field Summary
- Fields inherited from interface edu.gsu.cs.dmlab.datatypes.interfaces.IBaseTemporalObject
  baseTemporalComparator

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getId()`	Returns the primary key Id in a database, of the event that this object represents
`EventType`	`getType()`	Returns the type of event that this object represents.
`boolean`	`isInterpolated()`	Returns an indicator of whether the trajectory is interpolated or not.
`void`	`updateTimePeriod(org.joda.time.Interval period)`	Updates the time period that this object is valid

Methods inherited from interface edu.gsu.cs.dmlab.datatypes.interfaces.IBaseTemporalObject
compareTime, getTimePeriod, getUUID

Methods inherited from interface edu.gsu.cs.dmlab.datatypes.interfaces.ISpatialTemporalObj
getCentroid, getEnvelope, getGeometry, getVolume

- Method Detail
  - getId
```
int getId()
```
    Returns the primary key Id in a database, of the event that this object represents
    
    Returns:
    
    id of the event that this object represents if the event was already stored in the database. This will be -1 for objects created by interpolation because they have yet to be stored in the database.
  - isInterpolated
```
boolean isInterpolated()
```
    Returns an indicator of whether the trajectory is interpolated or not. This is just so we can have an indicator of this.
    
    Returns:
    
    True if the trajectory is interpolated, false if it is not.
  - updateTimePeriod
```
void updateTimePeriod(org.joda.time.Interval period)
```
    Updates the time period that this object is valid
    
    Parameters:
    
    period - the new period for this object to be considered valid over
  - getType
```
EventType getType()
```
    Returns the type of event that this object represents. It is usually a two letter designation such as AR for Active IRegion, SS for Sun Spot etc.
    
    Returns:
    
    the type of event that this object represents.