Package org.apache.cassandra.db

Interface Clustering<V>

All Superinterfaces:

Clusterable<V>, ClusteringPrefix<V>, IMeasurableMemory

All Known Implementing Classes:

ArrayClustering, BufferClustering, NativeClustering

public interface Clustering<V>
extends ClusteringPrefix<V>, IMeasurableMemory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Clustering.Serializer	Serializer for Clustering object.

Nested classes/interfaces inherited from interface org.apache.cassandra.db.ClusteringPrefix

ClusteringPrefix.Deserializer, ClusteringPrefix.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final Clustering<ByteBuffer>	EMPTY	Empty clustering for tables having no clustering columns.
static final Clustering.Serializer	serializer
static final Clustering<ByteBuffer>	STATIC_CLUSTERING	The special cased clustering used by all static rows.

Method Summary

Modifier and Type	Method	Description
default ClusteringBound<V>	asEndBound()	Returns this prefix as an end bound.
default ClusteringBound<V>	asStartBound()	Returns this prefix as a start bound.
default Clustering<?>	clone(ByteBufferCloner cloner)
static Clustering<ByteBuffer>	make(ByteBuffer... values)
default String	toCQLString(TableMetadata metadata)
default String	toString(TableMetadata metadata)	Generates a proper string representation of the prefix.
long	unsharedHeapSizeExcludingData()

Methods inherited from interface org.apache.cassandra.db.Clusterable

clustering

Methods inherited from interface org.apache.cassandra.db.ClusteringPrefix

accessor, bufferAt, clusteringString, dataSize, digest, get, getBufferArray, getRawValues, isBottom, isEmpty, isTop, kind, retainable, serializeAsPartitionKey, size, stringAt, validate, validate

Methods inherited from interface org.apache.cassandra.cache.IMeasurableMemory

unsharedHeapSize

Field Details

serializer

static final Clustering.Serializer serializer

STATIC_CLUSTERING

static final Clustering<ByteBuffer> STATIC_CLUSTERING

The special cased clustering used by all static rows. It is a special case in the sense that it's always empty, no matter how many clustering columns the table has.

EMPTY

static final Clustering<ByteBuffer> EMPTY

Empty clustering for tables having no clustering columns.

Method Details

unsharedHeapSizeExcludingData

long unsharedHeapSizeExcludingData()

clone

default Clustering<?> clone(ByteBufferCloner cloner)

asStartBound

default ClusteringBound<V> asStartBound()

Description copied from interface: ClusteringPrefix

Returns this prefix as a start bound. If this prefix is a bound, just returns it asserting that it is a start bound. If this prefix is a clustering, returns an included start bound. If this prefix is a boundary, returns an open bound of it

Specified by:

asStartBound in interface ClusteringPrefix<V>

asEndBound

default ClusteringBound<V> asEndBound()

Description copied from interface: ClusteringPrefix

Returns this prefix as an end bound. If this prefix is a bound, just returns it asserting that it is an end bound. If this prefix is a clustering, returns an included end bound. In this prefix is a boundary, returns a close bound of it.

Specified by:

asEndBound in interface ClusteringPrefix<V>

toString

default String toString(TableMetadata metadata)

Description copied from interface: ClusteringPrefix

Generates a proper string representation of the prefix.

Specified by:

toString in interface ClusteringPrefix<V>

Parameters:

metadata - the metadata for the table the clustering prefix is of.

Returns:

a human-readable string representation fo this prefix.

toCQLString

default String toCQLString(TableMetadata metadata)

make

static Clustering<ByteBuffer> make(ByteBuffer... values)