org.sensorhub.api.persistence

Interface IFeatureFilter

All Known Subinterfaces:

IFoiFilter

All Known Implementing Classes:

FeatureFilter, FoiFilter

public interface IFeatureFilter

Simple structure for defining filtering criteria when retrieving features from storage.
There is an implicit logical AND between all criteria.

Since:

May 13, 2015

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getFeatureIDs() Gets filter criteria for selecting features by ID. Only features identified with one of the listed IDs will be selected. If the list is null or empty, no filtering on ID will be applied.
com.vividsolutions.jts.geom.Polygon	getRoi() Gets filter criteria for selecting features based on their geometry. Only features whose geometry intersects the polygon will be selected. If the polygon is null, no filtering on location will be applied. The polygon must be expressed in the same coordinate reference system as the one used for storage.

Method Detail

getFeatureIDs

java.util.Collection<java.lang.String> getFeatureIDs()

Gets filter criteria for selecting features by ID.
Only features identified with one of the listed IDs will be selected.
If the list is null or empty, no filtering on ID will be applied.

Returns:

List of desired feature IDs

getRoi

com.vividsolutions.jts.geom.Polygon getRoi()

Gets filter criteria for selecting features based on their geometry.
Only features whose geometry intersects the polygon will be selected.
If the polygon is null, no filtering on location will be applied.
The polygon must be expressed in the same coordinate reference system as the one used for storage.

Returns:

Polygonal Region of Interest