Package org.apache.cassandra.db

Class NativeClustering

java.lang.Object

org.apache.cassandra.db.NativeClustering

All Implemented Interfaces:

IMeasurableMemory, Clusterable<ByteBuffer>, Clustering<ByteBuffer>, ClusteringPrefix<ByteBuffer>

public class NativeClustering
extends Object
implements Clustering<ByteBuffer>

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 interface org.apache.cassandra.db.Clustering

EMPTY, serializer, STATIC_CLUSTERING

Constructor Summary

Constructors

Constructor	Description
NativeClustering(NativeAllocator allocator, OpOrder.Group writeOp, Clustering<?> clustering)

Method Summary

Modifier and Type	Method	Description
ValueAccessor<ByteBuffer>	accessor()
ClusteringPrefix<ByteBuffer>	clustering()
int	dataSize()	The size of the data hold by this prefix.
final boolean	equals(Object o)
ByteBuffer	get(int i)	Retrieves the ith value of this prefix.
ByteBuffer[]	getBufferArray()
ByteBuffer[]	getRawValues()	The values of this prefix as an array.
final int	hashCode()
ClusteringPrefix.Kind	kind()
ClusteringPrefix<ByteBuffer>	retainable()	Return the key in a form that can be retained for longer-term use.
int	size()	The number of values in this prefix.
long	unsharedHeapSize()
long	unsharedHeapSizeExcludingData()

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

asEndBound, asStartBound, clone, toCQLString, toString

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

bufferAt, clusteringString, digest, isBottom, isEmpty, isTop, serializeAsPartitionKey, stringAt, validate, validate

Constructor Details

NativeClustering

public NativeClustering(NativeAllocator allocator,
 OpOrder.Group writeOp,
 Clustering<?> clustering)

Method Details

kind

public ClusteringPrefix.Kind kind()

Specified by:

kind in interface ClusteringPrefix<ByteBuffer>

clustering

public ClusteringPrefix<ByteBuffer> clustering()

Specified by:

clustering in interface Clusterable<ByteBuffer>

size

public int size()

Description copied from interface: ClusteringPrefix

The number of values in this prefix. There can't be more values that the this is a prefix of has of clustering columns.

Specified by:

size in interface ClusteringPrefix<ByteBuffer>

Returns:

the number of values in this prefix.

dataSize

public int dataSize()

Description copied from interface: ClusteringPrefix

The size of the data hold by this prefix.

Specified by:

dataSize in interface ClusteringPrefix<ByteBuffer>

Returns:

the size of the data hold by this prefix (this is not the size of the object in memory, just the size of the data it stores).

get

public ByteBuffer get(int i)

Description copied from interface: ClusteringPrefix

Retrieves the ith value of this prefix.

Specified by:

get in interface ClusteringPrefix<ByteBuffer>

Parameters:

i - the index of the value to retrieve. Must be such that 0 <= i < size().

Returns:

the ith value of this prefix. Note that a value can be null.

getRawValues

public ByteBuffer[] getRawValues()

Description copied from interface: ClusteringPrefix

The values of this prefix as an array.

Please note that this may or may not require an array creation. So 1) you should *not* modify the returned array and 2) it's more efficient to use ClusteringPrefix.size() and ClusteringPrefix.get(int) unless you actually need an array.

Specified by:

getRawValues in interface ClusteringPrefix<ByteBuffer>

Returns:

the values for this prefix as an array.

getBufferArray

public ByteBuffer[] getBufferArray()

Specified by:

getBufferArray in interface ClusteringPrefix<ByteBuffer>

accessor

public ValueAccessor<ByteBuffer> accessor()

Specified by:

accessor in interface ClusteringPrefix<ByteBuffer>

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<ByteBuffer>

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

retainable

public ClusteringPrefix<ByteBuffer> retainable()

Description copied from interface: ClusteringPrefix

Return the key in a form that can be retained for longer-term use. This means extracting keys stored in shared memory (i.e. in memtables) to minimized on-heap versions. If the object is already in minimal form, no action will be taken.

Specified by:

retainable in interface ClusteringPrefix<ByteBuffer>