org.bluedb.api.keys

Interface BlueKey

All Superinterfaces:

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

All Known Implementing Classes:

HashGroupedKey, IndexCompositeKey, IntegerKey, LongKey, StringKey, TimeFrameKey, TimeKey, UUIDKey, ValueKey

public interface BlueKey
extends java.io.Serializable, java.lang.Comparable<BlueKey>

A key that can be mapped to a value in a BlueCollection or BlueIndex.

Known implementations include TimeKey, TimeFrameKey, UUIDKey, StringKey, LongKey, IntegerKey

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.lang.Object>	nullSafeClassComparator

Method Summary

Modifier and Type	Method and Description
default int	compareCanonicalClassNames(BlueKey other) Compares the canonical class name so that two keys of different types can be ordered consistently
static int	compareCanonicalClassNames(java.lang.Object first, java.lang.Object second) Compares the canonical class name so that two keys of different types can be ordered consistently
default int	compareTo(BlueKey other)
static <T extends java.lang.Comparable<T>> int	compareWithNullsLast(T item1, T item2) Compares the the values in a null-safe way
boolean	equals(java.lang.Object object)
long	getGroupingNumber() Returns the grouping number which helps to determine the order and location of the key/value pairs on disk
default java.lang.Integer	getIntegerIdIfPresent() Convenience method to get the underlying Integer value if this is a IntegerKey
default java.lang.Long	getLongIdIfPresent() Convenience method to get the underlying Long value if this is a LongKey
int	hashCode()
default boolean	isInRange(long min, long max) Returns true if this key's grouping number is in the range [min, max] inclusive, else false
int	postGroupingNumberCompareTo(BlueKey other) This is used to order the key/value pairs on disk.
static int	unsafeCompareCanonicalClassNames(java.lang.Object first, java.lang.Object second) Compares the canonical class name so that two keys of different types can be ordered consistently

Field Detail

nullSafeClassComparator

static final java.util.Comparator<java.lang.Object> nullSafeClassComparator

Method Detail

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

compareTo

default int compareTo(BlueKey other)

Specified by:

compareTo in interface java.lang.Comparable<BlueKey>

postGroupingNumberCompareTo

int postGroupingNumberCompareTo(BlueKey other)

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.

getGroupingNumber

long getGroupingNumber()

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

Returns:

grouping number

getLongIdIfPresent

default java.lang.Long getLongIdIfPresent()

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

Returns:

the underlying Long value if this is a LongKey

getIntegerIdIfPresent

default java.lang.Integer getIntegerIdIfPresent()

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

Returns:

the underlying Integer value if this is a IntegerKey

isInRange

default boolean isInRange(long min,
                          long max)

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

compareCanonicalClassNames

default int compareCanonicalClassNames(BlueKey other)

Compares the canonical class name so that two keys of different types can be ordered consistently

Parameters:

other - the key that this is being compared against

Returns:

0 if this has the same class as other, or else a negative or positive int to indicate relative order

compareCanonicalClassNames

static int compareCanonicalClassNames(java.lang.Object first,
                                      java.lang.Object second)

Compares the canonical class name so that two keys of different types can be ordered consistently

Parameters:

first - the key to compare against second

second - the key to compare against first

Returns:

0 if the classes are the same, a negative number if first should come first and a positive number if second should

unsafeCompareCanonicalClassNames

static int unsafeCompareCanonicalClassNames(java.lang.Object first,
                                            java.lang.Object second)

Compares the canonical class name so that two keys of different types can be ordered consistently

Parameters:

first - key to compare against second

second - key to compare against first

Returns:

0 if the classes are the same, a negative number if first should come first and a positive number if second should

compareWithNullsLast

static <T extends java.lang.Comparable<T>> int compareWithNullsLast(T item1,
                                                                    T item2)

Compares the the values in a null-safe way

Type Parameters:

T - Any type that you want to compare

Parameters:

item1 - value to compare against item2

item2 - value to compare against item1

Returns:

0 if the classes are the same, a negative number if first should come first and a positive number if second should