org.bluedb.api.keys

Class TimeKey

java.lang.Object

org.bluedb.api.keys.TimeKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BlueKey>, BlueKey

Direct Known Subclasses:

TimeFrameKey

public class TimeKey
extends java.lang.Object
implements BlueKey

A key that can be mapped to a value in a BlueCollection or BlueIndex. Values inserted with this key will be ordered by time. I-node usage will scale with the size of the timeframe that your data covers.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.bluedb.api.keys.BlueKey

nullSafeClassComparator

Constructor Summary

Constructors

Constructor and Description
TimeKey(long id, long time)
TimeKey(java.lang.String id, long time)
TimeKey(java.util.UUID id, long time)
TimeKey(ValueKey id, long time)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getGroupingNumber() Returns the grouping number which helps to determine the order and location of the key/value pairs on disk
ValueKey	getId()
java.lang.Integer	getIntegerIdIfPresent() Convenience method to get the underlying Integer value if this is a IntegerKey
java.lang.Long	getLongIdIfPresent() Convenience method to get the underlying Long value if this is a LongKey
long	getTime()
int	hashCode()
int	postGroupingNumberCompareTo(BlueKey other) This is used to order the key/value pairs on disk.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bluedb.api.keys.BlueKey

compareCanonicalClassNames, compareCanonicalClassNames, compareTo, compareWithNullsLast, isInRange, unsafeCompareCanonicalClassNames

Constructor Detail

TimeKey

public TimeKey(long id,
               long time)

TimeKey

public TimeKey(java.lang.String id,
               long time)

TimeKey

public TimeKey(java.util.UUID id,
               long time)

TimeKey

public TimeKey(ValueKey id,
               long time)

Method Detail

getId

public ValueKey getId()

getTime

public long getTime()

getGroupingNumber

public final long getGroupingNumber()

Description copied from interface: BlueKey

Returns the grouping number which helps to determine the order and location of the key/value pairs on disk

Specified by:

getGroupingNumber in interface BlueKey

Returns:

grouping number

hashCode

public int hashCode()

Specified by:

hashCode in interface BlueKey

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface BlueKey

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

postGroupingNumberCompareTo

public final int postGroupingNumberCompareTo(BlueKey other)

Description copied from interface: BlueKey

This is used to order the key/value pairs on disk. If this is being called then other is not null and the grouping numbers matched.

Specified by:

postGroupingNumberCompareTo in interface BlueKey

getIntegerIdIfPresent

public java.lang.Integer getIntegerIdIfPresent()

Description copied from interface: BlueKey

Convenience method to get the underlying Integer value if this is a IntegerKey

Specified by:

getIntegerIdIfPresent in interface BlueKey

Returns:

the underlying Integer value if this is a IntegerKey

getLongIdIfPresent

public java.lang.Long getLongIdIfPresent()

Description copied from interface: BlueKey

Convenience method to get the underlying Long value if this is a LongKey

Specified by:

getLongIdIfPresent in interface BlueKey

Returns:

the underlying Long value if this is a LongKey