Package org.apache.cassandra.index.sai.utils

Interface PrimaryKey

All Superinterfaces:

ByteComparable, Comparable<PrimaryKey>

public interface PrimaryKey
extends Comparable<PrimaryKey>, ByteComparable

Representation of the primary key for a row consisting of the DecoratedKey and Clustering associated with a Row. The PrimaryKey.Factory.TokenOnlyPrimaryKey is used by the StorageAttachedIndexSearcher to position the search within the query range.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PrimaryKey.Factory
static enum	PrimaryKey.Kind	See the javadoc for kind() for how this enum is used.

Nested classes/interfaces inherited from interface org.apache.cassandra.utils.bytecomparable.ByteComparable

ByteComparable.Version

Field Summary

Fields inherited from interface org.apache.cassandra.utils.bytecomparable.ByteComparable

EMPTY

Method Summary

Modifier and Type	Method	Description
ByteSource	asComparableBytes(ByteComparable.Version version)	Returns the PrimaryKey as a ByteSource byte comparable representation.
Clustering<?>	clustering()	Returns the Clustering representing the clustering component of the PrimaryKey.
default int	compareTo(PrimaryKey key, boolean strict)
boolean	equals(Object obj, boolean strict)
PrimaryKey.Kind	kind()	Returns the PrimaryKey.Kind of the PrimaryKey.
DecoratedKey	partitionKey()	Returns the DecoratedKey representing the partition key of the PrimaryKey.
Token	token()	Returns the Token component of the PrimaryKey
default PrimaryKey	toStatic()

Methods inherited from interface org.apache.cassandra.utils.bytecomparable.ByteComparable

byteComparableAsString

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

kind

PrimaryKey.Kind kind()

Returns the PrimaryKey.Kind of the PrimaryKey. The PrimaryKey.Kind is used locally in the Comparable.compareTo(Object) methods to determine how far the comparision needs to go between keys.

The PrimaryKey.Kind values have a categorization of isClustering. This indicates whether the key belongs to a table with clustering tables or not.

token

Token token()

Returns the Token component of the PrimaryKey

partitionKey

DecoratedKey partitionKey()

Returns the DecoratedKey representing the partition key of the PrimaryKey.

Note: This cannot be null but some PrimaryKey implementations can throw UnsupportedOperationException if they do not support partition keys.

clustering

Clustering<?> clustering()

Returns the Clustering representing the clustering component of the PrimaryKey.

Note: This cannot be null but some PrimaryKey implementations can throw UnsupportedOperationException if they do not support clustering columns.

asComparableBytes

ByteSource asComparableBytes(ByteComparable.Version version)

Returns the PrimaryKey as a ByteSource byte comparable representation.

It is important that these representations are only ever used with byte comparables using the same elements. This means that asComparableBytes responses can only be used together from the same PrimaryKey implementation.

Specified by:

asComparableBytes in interface ByteComparable

Parameters:

version - the ByteComparable.Version to use for the implementation

Returns:

the ByteSource byte comparable.

Throws:

UnsupportedOperationException - for PrimaryKey implementations that are not byte-comparable

toStatic

default PrimaryKey toStatic()

compareTo

default int compareTo(PrimaryKey key,
 boolean strict)

equals

boolean equals(Object obj,
 boolean strict)