Package org.sensorhub.api.datastore.feature

Class FeatureKey

java.lang.Object

org.sensorhub.api.resource.ResourceKey<FeatureKey>

org.sensorhub.api.datastore.feature.FeatureKey

All Implemented Interfaces:

Comparable<FeatureKey>

public class FeatureKey
extends ResourceKey<FeatureKey>

Immutable key object used to index features in data stores.
The key includes the feature internal ID and its validity time stamp.

Since:

Mar 19, 2018

Field Summary

Fields

Modifier and Type	Field	Description
static final Instant	TIMELESS
protected Instant	validStartTime

Fields inherited from class org.sensorhub.api.resource.ResourceKey

internalID

Constructor Summary

Constructors

Constructor	Description
FeatureKey(int scope, long internalID, Instant validStartTime)	Creates a key for the version of a feature valid at a specific time
FeatureKey(BigId internalID)	Creates a key for a timeless feature
FeatureKey(BigId internalID, Instant validStartTime)	Creates a key for the version of a feature valid at a specific time

Method Summary

Modifier and Type	Method	Description
int	compareTo(FeatureKey other)
boolean	equals(Object obj)
Instant	getValidStartTime()
int	hashCode()
String	toString()

Methods inherited from class org.sensorhub.api.resource.ResourceKey

getInternalID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TIMELESS

public static final Instant TIMELESS

validStartTime

protected Instant validStartTime

Constructor Details

FeatureKey

public FeatureKey(BigId internalID)

Creates a key for a timeless feature

Parameters:

internalID - Internal ID of desired feature

FeatureKey

public FeatureKey(BigId internalID,
 Instant validStartTime)

Creates a key for the version of a feature valid at a specific time

Parameters:

internalID - Internal ID of desired feature

validStartTime - Start of feature version validity period

FeatureKey

public FeatureKey(int scope,
 long internalID,
 Instant validStartTime)

Creates a key for the version of a feature valid at a specific time

Parameters:

scope - Internal ID scope

internalID - Internal ID of desired feature

validStartTime - Start of feature version validity period

Method Details

getValidStartTime

public Instant getValidStartTime()

Returns:

The start of validity of the feature description.
If null or equal to TIMELESS, the feature will always be returned by queries containing a temporal filter

toString

public String toString()

Overrides:

toString in class ResourceKey<FeatureKey>

hashCode

public int hashCode()

Overrides:

hashCode in class ResourceKey<FeatureKey>

equals

public boolean equals(Object obj)

Overrides:

equals in class ResourceKey<FeatureKey>

compareTo

public int compareTo(FeatureKey other)

Specified by:

compareTo in interface Comparable<FeatureKey>

Overrides:

compareTo in class ResourceKey<FeatureKey>