org.sensorhub.api.persistence

Class ObsKey

java.lang.Object

org.sensorhub.api.persistence.DataKey

org.sensorhub.api.persistence.ObsKey

All Implemented Interfaces:

java.io.Serializable

public class ObsKey
extends DataKey

Class for keys associated to observations in SensorHub. This type of key is used to store observations in storage.

Since:

Nov 6, 2010

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	foiID ID of feature of interest (i.e.
double	resultTime Observation result time (i.e.
com.vividsolutions.jts.geom.Polygon	samplingGeometry Sampling Geometry (i.e.

Fields inherited from class org.sensorhub.api.persistence.DataKey

producerID, recordType, timeStamp

Constructor Summary

Constructors

Constructor and Description
ObsKey(java.lang.String recordType, java.lang.String foiID, double timeStamp) Default constructor providing mandatory indexing metadata
ObsKey(java.lang.String recordType, java.lang.String producerID, java.lang.String foiID, double timeStamp) DConstructor with specific entity ID

Method Summary

Modifier and Type	Method and Description
protected void	toString(java.lang.StringBuilder buf)

Methods inherited from class org.sensorhub.api.persistence.DataKey

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

foiID

public java.lang.String foiID

ID of feature of interest (i.e. feature whose properties were observed/measured).
If value is null, observation will never be selected when filtering on FoI ID

resultTime

public double resultTime

Observation result time (i.e. time at which the observation result was obtained).
If value is NaN, observation will never be selected when filtering on result time

samplingGeometry

public com.vividsolutions.jts.geom.Polygon samplingGeometry

Sampling Geometry (i.e. area or volume in 2D or 3D space, where the observation was made).
If value is null, FoI geometry is used instead when provided. If neither geometry is provided, observation will never be selected when filtering on geometry.
In a given data store, all geometries must be expressed in the same coordinate reference system.

Constructor Detail

ObsKey

public ObsKey(java.lang.String recordType,
              java.lang.String foiID,
              double timeStamp)

Default constructor providing mandatory indexing metadata

Parameters:

recordType - DataKey.recordType

foiID - foiID

timeStamp - DataKey.timeStamp

ObsKey

public ObsKey(java.lang.String recordType,
              java.lang.String producerID,
              java.lang.String foiID,
              double timeStamp)

DConstructor with specific entity ID

Parameters:

recordType - DataKey.recordType

producerID - DataKey.producerID

foiID - foiID

timeStamp - DataKey.timeStamp

Method Detail

toString

protected void toString(java.lang.StringBuilder buf)

Overrides:

toString in class DataKey