org.apache.cassandra.db

Class BufferClustering

java.lang.Object

org.apache.cassandra.db.AbstractOnHeapClusteringPrefix<java.nio.ByteBuffer>

org.apache.cassandra.db.AbstractBufferClusteringPrefix

org.apache.cassandra.db.BufferClustering

All Implemented Interfaces:

IMeasurableMemory, Clusterable<java.nio.ByteBuffer>, Clustering<java.nio.ByteBuffer>, ClusteringPrefix<java.nio.ByteBuffer>

public class BufferClustering
extends AbstractBufferClusteringPrefix
implements Clustering<java.nio.ByteBuffer>

The clustering column values for a row.

A Clustering is a ClusteringPrefix that must always be "complete", i.e. have as many values as there is clustering columns in the table it is part of. It is the clustering prefix used by rows.

Note however that while it's size must be equal to the table clustering size, a clustering can have null values (this is currently only allowed in COMPACT table for historical reasons, but we could imagine lifting that limitation if we decide it make sense from a CQL point of view).

Nested Class Summary

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

Clustering.Serializer

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

ClusteringPrefix.Deserializer, ClusteringPrefix.Kind

Field Summary

Fields inherited from class org.apache.cassandra.db.AbstractBufferClusteringPrefix

EMPTY_VALUES_ARRAY

Fields inherited from class org.apache.cassandra.db.AbstractOnHeapClusteringPrefix

kind, values

Fields inherited from interface org.apache.cassandra.db.Clustering

EMPTY, serializer, STATIC_CLUSTERING

Constructor Summary

Constructors

Constructor and Description
BufferClustering(java.nio.ByteBuffer... values)

Method Summary

Modifier and Type	Method and Description
static BufferClustering	make(java.nio.ByteBuffer... values)
long	unsharedHeapSize()
long	unsharedHeapSizeExcludingData()

Methods inherited from class org.apache.cassandra.db.AbstractBufferClusteringPrefix

accessor, getBufferArray, minimize

Methods inherited from class org.apache.cassandra.db.AbstractOnHeapClusteringPrefix

clustering, equals, get, getRawValues, hashCode, kind, size

Methods inherited from class java.lang.Object

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

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

copy, toCQLString, toString

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

accessor, bufferAt, dataSize, digest, equals, equals, get, getBufferArray, getRawValues, hashCode, isBottom, isEmpty, isTop, kind, minimize, serializeAsPartitionKey, size, stringAt, validate

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

clustering

Constructor Detail

BufferClustering

public BufferClustering(java.nio.ByteBuffer... values)

Method Detail

unsharedHeapSize

public long unsharedHeapSize()

Specified by:

unsharedHeapSize in interface IMeasurableMemory

Returns:

the amount of on-heap memory retained by the object that might be reclaimed if the object were reclaimed, i.e. it should try to exclude globally cached data where possible, or counting portions of arrays that are referenced by the object but used by other objects only (e.g. slabbed byte-buffers), etc.

unsharedHeapSizeExcludingData

public long unsharedHeapSizeExcludingData()

Specified by:

unsharedHeapSizeExcludingData in interface Clustering<java.nio.ByteBuffer>

make

public static BufferClustering make(java.nio.ByteBuffer... values)

Specified by:

make in interface Clustering<java.nio.ByteBuffer>