IIndexer (DMLab Library API for 0.0.4-SNAPSHOT)

All Known Subinterfaces:

ISTTrackingEventIndexer, ISTTrackingTrajectoryIndexer

All Known Implementing Classes:

AbsMatIndexer, BasicEventIndexer, BasicTrackIndexer, TreeBasedEventIndexer, TreeBasedTrackIndexer
```
public interface IIndexer<T extends IBaseTemporalObject>
```
The base interface for indexes that store objects of IBaseDatType or derived from objects that implement that data type.

Author:

Thaddeus Gholston, Data Mining Lab, Georgia State University

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<T>`	`getAll()`	Returns the list of all objects in the index.
`org.joda.time.DateTime`	`getFirstTime()`	Gets the earliest start time in the index.
`org.joda.time.DateTime`	`getLastTime()`	Gets the latest end time in the index.
`List<T>`	`search(org.joda.time.Interval timePeriod, org.locationtech.jts.geom.Geometry searchArea)`	Searches the index for any objects that intersect the query time and the query search area.

- Method Detail
  - getFirstTime
```
org.joda.time.DateTime getFirstTime()
```
    Gets the earliest start time in the index. That way you can check before you waste time querying the index for objects that don't exist.
    
    Returns:
    
    The earliest start time in the index.
  - getLastTime
```
org.joda.time.DateTime getLastTime()
```
    Gets the latest end time in the index. That way you can check before you waste time querying the index for objects that don't exist.
    
    Returns:
    
    The latest end time in the index.
  - search
```
List<T> search(org.joda.time.Interval timePeriod,
               org.locationtech.jts.geom.Geometry searchArea)
```
    Searches the index for any objects that intersect the query time and the query search area. This method is intended to look forward in time for these objects as is done to find the next possible detection for a given detection.
    
    Parameters:
    
    timePeriod - The time period to query the index with.
    
    searchArea - The search area to search for intersections with.
    
    Returns:
    
    A list of the objects in the index that intersect the query time and the query search area.
  - getAll
```
List<T> getAll()
```
    Returns the list of all objects in the index.
    
    Returns:
    
    A list of all the objects in the index.