Package edu.gsu.cs.dmlab.datatypes.interfaces

Interface ISTTrackingEvent

All Superinterfaces:

IBaseTemporalObject, ISpatialTemporalObj

All Known Implementing Classes:

GeneralSTTrackingEvent

public interface ISTTrackingEvent
extends ISpatialTemporalObj

Is the public interface for events processed by the tracking 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

Modifier and Type	Method	Description
int	getId()	Returns the primary key Id in a database, of the event that this object represents
ISTTrackingEvent	getNext()	Returns a pointer to the event detection that is considered the next detection of the same object.
ISTTrackingEvent	getPrevious()	Returns a pointer to the event detection that is considered the previous detection of the same object.
EventType	getType()	Returns the type of event that this object represents.
void	setNext(ISTTrackingEvent event)	Sets a pointer to the event detection that is considered the next detection of the same object.
void	setPrevious(ISTTrackingEvent event)	Sets a pointer to the event detection that is considered the previous detection of the same object.
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

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.

getPrevious

ISTTrackingEvent getPrevious()

Returns a pointer to the event detection that is considered the previous detection of the same object.

Returns:

pointer to the previous detection in the chain.

setPrevious

void setPrevious(ISTTrackingEvent event)

Sets a pointer to the event detection that is considered the previous detection of the same object. This method only changes the pointer from null to a non-null value. Once it is set, it does not change with the next call.

Parameters:

event - the previous detection in the chain

getNext

ISTTrackingEvent getNext()

Returns a pointer to the event detection that is considered the next detection of the same object.

Returns:

a pointer to the next detection in the chain.

setNext

void setNext(ISTTrackingEvent event)

Sets a pointer to the event detection that is considered the next detection of the same object. This method only changes the pointer from null to a non-null value. Once it is set, it does not change with the next call.

Parameters:

event - the next detection in the chain