org.sensorhub.api.persistence

Class DataKey

java.lang.Object

org.sensorhub.api.persistence.DataKey

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ObsKey

public class DataKey
extends java.lang.Object
implements java.io.Serializable

Base class for all keys associated to data records in SensorHub. Keys are used to store time stamped data records in storage.

Since:

Nov 6, 2010

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	producerID ID of data producer (i.e.
java.lang.String	recordType ID of record type (i.e.
double	timeStamp Time stamp of data record (e.g.

Constructor Summary

Constructors

Constructor and Description
DataKey(java.lang.String recordType, double timeStamp) Default constructor providing basic indexing metadata
DataKey(java.lang.String recordType, java.lang.String producerID, double timeStamp) Constructor with specific producer ID

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

recordType

public java.lang.String recordType

ID of record type (i.e. maps to a record structure definition).
This field cannot be null.

timeStamp

public double timeStamp

Time stamp of data record (e.g. measurement sampling time).
If value is NaN, data record will never be selected when filtering on time stamp

producerID

public java.lang.String producerID

ID of data producer (i.e. the entity that produced the data record).
If value is null, data record will never be selected when filtering on producer ID

Constructor Detail

DataKey

public DataKey(java.lang.String recordType,
               double timeStamp)

Default constructor providing basic indexing metadata

Parameters:

recordType - recordType

timeStamp - timeStamp

DataKey

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

Constructor with specific producer ID

Parameters:

recordType - recordType

producerID - producerID

timeStamp - timeStamp

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

protected void toString(java.lang.StringBuilder buf)