org.bluedb.api.keys

Class TimeFrameKey

java.lang.Object

org.bluedb.api.keys.TimeKey

org.bluedb.api.keys.TimeFrameKey

All Implemented Interfaces:

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

public final class TimeFrameKey
extends TimeKey

A key that can be mapped to a value in a BlueCollection or BlueIndex. Values inserted with this key will be ordered by start 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
TimeFrameKey(long id, long startTime, long endTime)
TimeFrameKey(java.lang.String id, long startTime, long endTime)
TimeFrameKey(java.util.UUID id, long startTime, long endTime)
TimeFrameKey(ValueKey key, long startTime, long endTime)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getEndTime()
long	getStartTime()
int	hashCode()
boolean	isInRange(long min, long max) Returns true if this key's grouping number is in the range [min, max] inclusive, else false
java.lang.String	toString()

Methods inherited from class org.bluedb.api.keys.TimeKey

getGroupingNumber, getId, getIntegerIdIfPresent, getLongIdIfPresent, getTime, postGroupingNumberCompareTo

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, unsafeCompareCanonicalClassNames

Constructor Detail

TimeFrameKey

public TimeFrameKey(long id,
                    long startTime,
                    long endTime)

TimeFrameKey

public TimeFrameKey(java.lang.String id,
                    long startTime,
                    long endTime)

TimeFrameKey

public TimeFrameKey(java.util.UUID id,
                    long startTime,
                    long endTime)

TimeFrameKey

public TimeFrameKey(ValueKey key,
                    long startTime,
                    long endTime)

Method Detail

hashCode

public int hashCode()

Specified by:

hashCode in interface BlueKey

Overrides:

hashCode in class TimeKey

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface BlueKey

Overrides:

equals in class TimeKey

isInRange

public boolean isInRange(long min,
                         long max)

Description copied from interface: BlueKey

Returns true if this key's grouping number is in the range [min, max] inclusive, else false

Parameters:

min - the minimum grouping number

max - the maximum grouping number

Returns:

true if this key's grouping number is in the range [min, max] inclusive, else false

getStartTime

public long getStartTime()

Returns:

the start time of this key

getEndTime

public long getEndTime()

Returns:

the end time of this key

toString

public java.lang.String toString()

Overrides:

toString in class TimeKey