Uses of Interface org.apache.cassandra.db.Clustering (apache-cassandra API)
Date: 2018-02-14

## Uses of Interface
org.apache.cassandra.db.Clustering

- Packages that use Clustering
  Package | Description
  --- | ---
  org.apache.cassandra.cache |
  org.apache.cassandra.cql3 |
  org.apache.cassandra.cql3.restrictions |
  org.apache.cassandra.cql3.selection |
  org.apache.cassandra.cql3.statements |
  org.apache.cassandra.db |
  org.apache.cassandra.db.aggregation |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.db.partitions |
  org.apache.cassandra.db.rows |
  org.apache.cassandra.index.internal |
  org.apache.cassandra.index.internal.composites |
  org.apache.cassandra.index.internal.keys |
  org.apache.cassandra.service.pager |
  org.apache.cassandra.utils.memory |

- - ### Uses of Clustering in org.apache.cassandra.cache

    Methods in org.apache.cassandra.cache with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `static CounterCacheKey` | CounterCacheKey.`create(Pair<java.lang.String,java.lang.String> ksAndCFName, java.nio.ByteBuffer partitionKey, Clustering clustering, ColumnDefinition c, CellPath path)`

  - ### Uses of Clustering in org.apache.cassandra.cql3

    Methods in org.apache.cassandra.cql3 that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Clustering` | UpdateParameters.`currentClustering()`

    Methods in org.apache.cassandra.cql3 with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `void` | ColumnConditions.`addConditionsTo(CQL3CasRequest request, Clustering clustering, QueryOptions options)` Adds the conditions to the specified CAS request.
    `void` | Conditions.`addConditionsTo(CQL3CasRequest request, Clustering clustering, QueryOptions options)` Adds the conditions to the specified CAS request.
    `Row` | UpdateParameters.`getPrefetchedRow(DecoratedKey key, Clustering clustering)` Returns the prefetched row with the already performed modifications.
    `RangeTombstone` | UpdateParameters.`makeRangeTombstone(ClusteringComparator comparator, Clustering clustering)`
    `void` | UpdateParameters.`newRow(Clustering clustering)`

  - ### Uses of Clustering in org.apache.cassandra.cql3.restrictions

    Methods in org.apache.cassandra.cql3.restrictions that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `java.util.NavigableSet<Clustering>` | StatementRestrictions.`getClusteringColumns(QueryOptions options)` Returns the requested clustering columns.

  - ### Uses of Clustering in org.apache.cassandra.cql3.selection

    Methods in org.apache.cassandra.cql3.selection with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `void` | Selection.ResultSetBuilder.`newRow(DecoratedKey partitionKey, Clustering clustering)` Notifies this `Builder` that a new row is being processed.

  - ### Uses of Clustering in org.apache.cassandra.cql3.statements

    Methods in org.apache.cassandra.cql3.statements that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `java.util.NavigableSet<Clustering>` | ModificationStatement.`createClustering(QueryOptions options)`

    Methods in org.apache.cassandra.cql3.statements with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `void` | CQL3CasRequest.`addConditions(Clustering clustering, java.util.Collection<ColumnCondition> conds, QueryOptions options)`
    `void` | ModificationStatement.`addConditions(Clustering clustering, CQL3CasRequest request, QueryOptions options)`
    `void` | CQL3CasRequest.`addExist(Clustering clustering)`
    `void` | CQL3CasRequest.`addNotExist(Clustering clustering)`
    `void` | CQL3CasRequest.`addRowUpdate(Clustering clustering, ModificationStatement stmt, QueryOptions options, long timestamp)`
    `void` | DeleteStatement.`addUpdateForKey(PartitionUpdate update, Clustering clustering, UpdateParameters params)`
    `abstract void` | ModificationStatement.`addUpdateForKey(PartitionUpdate update, Clustering clustering, UpdateParameters params)`
    `void` | UpdateStatement.`addUpdateForKey(PartitionUpdate update, Clustering clustering, UpdateParameters params)`

  - ### Uses of Clustering in org.apache.cassandra.db

    Classes in org.apache.cassandra.db that implement Clustering
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BufferClustering` The clustering column values for a row.
    `class` | `NativeClustering`

    Fields in org.apache.cassandra.db declared as Clustering
    Modifier and Type | Field and Description
    --- | ---
    `Clustering` | LegacyLayout.LegacyCellName.`clustering`
    `static Clustering` | Clustering.`EMPTY` Empty clustering for tables having no clustering columns.
    `static Clustering` | Clustering.`STATIC_CLUSTERING` The special cased clustering used by all static rows.

    Methods in org.apache.cassandra.db that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `abstract Clustering` | CBuilder.`build()`
    `abstract Clustering` | CBuilder.`buildWith(java.nio.ByteBuffer value)`
    `abstract Clustering` | CBuilder.`buildWith(java.util.List<java.nio.ByteBuffer> newValues)`
    `default Clustering` | Clustering.`copy(AbstractAllocator allocator)`
    `static Clustering` | LegacyLayout.`decodeClustering(CFMetaData metadata, java.nio.ByteBuffer value)`
    `Clustering` | Clustering.Serializer.`deserialize(java.nio.ByteBuffer in, int version, java.util.List<AbstractType<?>> types)`
    `Clustering` | Clustering.Serializer.`deserialize(DataInputPlus in, int version, java.util.List<AbstractType<?>> types)`
    `Clustering` | ClusteringPrefix.Deserializer.`deserializeNextClustering()`
    `Clustering` | LegacyLayout.LegacyBound.`getAsClustering(CFMetaData metadata)`
    `Clustering` | DataRange.Paging.`getLastReturned()`
    `static Clustering` | Clustering.`make(java.nio.ByteBuffer... values)`
    `Clustering` | ClusteringComparator.`make(java.lang.Object... values)` Creates a row clustering based on the clustering values.

    Methods in org.apache.cassandra.db that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `abstract java.util.NavigableSet<Clustering>` | MultiCBuilder.`build()` Builds the `clusterings`.

    Methods in org.apache.cassandra.db with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `int` | ClusteringComparator.`compare(Clustering c1, Clustering c2)`
    `int` | ClusteringComparator.`compare(Clustering c1, Clustering c2, int size)` Compares the specified part of the specified clusterings.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, DecoratedKey key, Clustering name)` Creates a new single partition name command for the provided row.
    `DataRange` | DataRange.`forPaging(AbstractBounds<PartitionPosition> range, ClusteringComparator comparator, Clustering lastReturned, boolean inclusive)` Returns a new `DataRange` for use when paging `this` range.
    `Slice` | Slice.`forPaging(ClusteringComparator comparator, Clustering lastReturned, boolean inclusive, boolean reversed)` Returns a slice for continuing paging from the last returned clustering prefix.
    `abstract Slices` | Slices.`forPaging(ClusteringComparator comparator, Clustering lastReturned, boolean inclusive, boolean reversed)` Returns slices for continuing the paging of those slices given the last returned clustering prefix.
    `SinglePartitionReadCommand` | SinglePartitionReadCommand.`forPaging(Clustering lastReturned, DataLimits limits)` Returns a new command suitable to paging from the last returned row.
    `ClockAndCount` | ColumnFamilyStore.`getCachedCounter(java.nio.ByteBuffer partitionKey, Clustering clustering, ColumnDefinition column, CellPath path)`
    `boolean` | Slices.InOrderTester.`includes(Clustering value)`
    `boolean` | RangeTombstoneList.`isDeleted(Clustering clustering, Cell cell)` Returns whether the given name/timestamp pair is deleted by one of the tombstone of this RangeTombstoneList.
    `static Slice` | Slice.`make(Clustering clustering)`
    `static Slice` | Slice.`make(Clustering start, Clustering end)`
    `void` | ColumnFamilyStore.`putCachedCounter(java.nio.ByteBuffer partitionKey, Clustering clustering, ColumnDefinition column, CellPath path, ClockAndCount clockAndCount)`
    `RangeTombstone` | DeletionInfo.`rangeCovering(Clustering name)`
    `RangeTombstone` | MutableDeletionInfo.`rangeCovering(Clustering name)`
    `RangeTombstone` | RangeTombstoneList.`search(Clustering name)`
    `DeletionTime` | RangeTombstoneList.`searchDeletionTime(Clustering name)` Returns the DeletionTime for the tombstone overlapping `name` (there can't be more than one), or null if `name` is not covered by any tombstone.
    `abstract boolean` | Slices.`selects(Clustering clustering)` Whether a given clustering (row) is selected by this `Slices` object.
    `boolean` | PartitionRangeReadCommand.`selectsClustering(DecoratedKey key, Clustering clustering)`
    `boolean` | ReadQuery.`selectsClustering(DecoratedKey key, Clustering clustering)`
    `boolean` | SinglePartitionReadCommand.`selectsClustering(DecoratedKey key, Clustering clustering)`
    `boolean` | SinglePartitionReadCommand.Group.`selectsClustering(DecoratedKey key, Clustering clustering)`
    `void` | Clustering.Serializer.`serialize(Clustering clustering, DataOutputPlus out, int version, java.util.List<AbstractType<?>> types)`
    `java.nio.ByteBuffer` | Clustering.Serializer.`serialize(Clustering clustering, int version, java.util.List<AbstractType<?>> types)`
    `long` | Clustering.Serializer.`serializedSize(Clustering clustering, int version, java.util.List<AbstractType<?>> types)`

    Method parameters in org.apache.cassandra.db with type arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, DecoratedKey key, java.util.NavigableSet<Clustering> names)` Creates a new single partition name command for the provided rows.

    Constructors in org.apache.cassandra.db with parameters of type Clustering
    Constructor and Description
    `NativeClustering(NativeAllocator allocator, OpOrder.Group writeOp, Clustering clustering)`

  - ### Uses of Clustering in org.apache.cassandra.db.aggregation

    Methods in org.apache.cassandra.db.aggregation that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Clustering` | GroupingState.`clustering()` Returns the last row clustering or `null` if either no rows has been processed yet or the last row was a static row.

    Methods in org.apache.cassandra.db.aggregation with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `abstract boolean` | GroupMaker.`isNewGroup(DecoratedKey partitionKey, Clustering clustering)` Checks if a given row belongs to the same group that the previous row or not.

    Constructors in org.apache.cassandra.db.aggregation with parameters of type Clustering
    Constructor and Description
    `GroupingState(java.nio.ByteBuffer partitionKey, Clustering clustering)`

  - ### Uses of Clustering in org.apache.cassandra.db.filter

    Methods in org.apache.cassandra.db.filter that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `java.util.NavigableSet<Clustering>` | ClusteringIndexNamesFilter.`requestedRows()` The set of requested rows.

    Methods in org.apache.cassandra.db.filter with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | RowFilter.`clusteringKeyRestrictionsAreSatisfiedBy(Clustering clustering)` Returns true if all of the expressions within this filter that apply to the clustering key are satisfied by the given Clustering, false otherwise.
    `ClusteringIndexFilter` | ClusteringIndexFilter.`forPaging(ClusteringComparator comparator, Clustering lastReturned, boolean inclusive)` Returns a filter for continuing the paging of this filter given the last returned clustering prefix.
    `ClusteringIndexNamesFilter` | ClusteringIndexNamesFilter.`forPaging(ClusteringComparator comparator, Clustering lastReturned, boolean inclusive)`
    `ClusteringIndexSliceFilter` | ClusteringIndexSliceFilter.`forPaging(ClusteringComparator comparator, Clustering lastReturned, boolean inclusive)`
    `boolean` | ClusteringIndexFilter.`selects(Clustering clustering)` Whether a given row is selected by this filter.
    `boolean` | ClusteringIndexNamesFilter.`selects(Clustering clustering)`
    `boolean` | ClusteringIndexSliceFilter.`selects(Clustering clustering)`

    Constructor parameters in org.apache.cassandra.db.filter with type arguments of type Clustering
    Constructor and Description
    `ClusteringIndexNamesFilter(java.util.NavigableSet<Clustering> clusterings, boolean reversed)`

  - ### Uses of Clustering in org.apache.cassandra.db.partitions

    Methods in org.apache.cassandra.db.partitions that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Clustering` | PartitionUpdate.CounterMark.`clustering()`

    Methods in org.apache.cassandra.db.partitions that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `SearchIterator<Clustering,Row>` | AbstractBTreePartition.`searchIterator(ColumnFilter columns, boolean reversed)`
    `SearchIterator<Clustering,Row>` | AtomicBTreePartition.`searchIterator(ColumnFilter columns, boolean reversed)`
    `SearchIterator<Clustering,Row>` | Partition.`searchIterator(ColumnFilter columns, boolean reversed)` Returns an iterator that allows to search specific rows efficiently.

    Methods in org.apache.cassandra.db.partitions with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Row` | AbstractBTreePartition.`getRow(Clustering clustering)`
    `Row` | AtomicBTreePartition.`getRow(Clustering clustering)`
    `Row` | Partition.`getRow(Clustering clustering)` Returns the row corresponding to the provided clustering, or null if there is not such row.

  - ### Uses of Clustering in org.apache.cassandra.db.rows

    Fields in org.apache.cassandra.db.rows declared as Clustering
    Modifier and Type | Field and Description
    --- | ---
    `protected Clustering` | BTreeRow.Builder.`clustering`

    Methods in org.apache.cassandra.db.rows that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Clustering` | BTreeRow.`clustering()`
    `Clustering` | BTreeRow.Builder.`clustering()`
    `Clustering` | Row.`clustering()` The clustering values for this row.
    `Clustering` | Row.Builder.`clustering()` The clustering for the row that is currently being built.
    `Clustering` | Row.Merger.`mergedClustering()`

    Methods in org.apache.cassandra.db.rows with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `static BTreeRow` | BTreeRow.`create(Clustering clustering, LivenessInfo primaryKeyLivenessInfo, Row.Deletion deletion, java.lang.Object[] btree)`
    `static BTreeRow` | BTreeRow.`create(Clustering clustering, LivenessInfo primaryKeyLivenessInfo, Row.Deletion deletion, java.lang.Object[] btree, int minDeletionTime)`
    `static BTreeRow` | BTreeRow.`emptyDeletedRow(Clustering clustering, Row.Deletion deletion)`
    `static BTreeRow` | BTreeRow.`emptyRow(Clustering clustering)`
    `void` | BTreeRow.Builder.`newRow(Clustering clustering)`
    `void` | Row.Builder.`newRow(Clustering clustering)` Prepares the builder to build a new row of clustering `clustering`.
    `static BTreeRow` | BTreeRow.`noCellLiveRow(Clustering clustering, LivenessInfo primaryKeyLivenessInfo)`
    `void` | RowDiffListener.`onCell(int i, Clustering clustering, Cell merged, Cell original)` Called for any cell that is either in the merged row or in input `i`.
    `void` | RowDiffListener.`onComplexDeletion(int i, Clustering clustering, ColumnDefinition column, DeletionTime merged, DeletionTime original)` Called for every (non-live) complex deletion of any complex column present in either the merged row of input `i`.
    `void` | RowDiffListener.`onDeletion(int i, Clustering clustering, Row.Deletion merged, Row.Deletion original)` Called for the row deletion of input `i`.
    `void` | RowDiffListener.`onPrimaryKeyLivenessInfo(int i, Clustering clustering, LivenessInfo merged, LivenessInfo original)` Called for the row primary key liveness info of input `i`.
    `static BTreeRow` | BTreeRow.`singleCellRow(Clustering clustering, Cell cell)`

  - ### Uses of Clustering in org.apache.cassandra.index.internal

    Fields in org.apache.cassandra.index.internal declared as Clustering
    Modifier and Type | Field and Description
    --- | ---
    `Clustering` | IndexEntry.`indexClustering`
    `Clustering` | IndexEntry.`indexedEntryClustering`

    Methods in org.apache.cassandra.index.internal that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `protected Clustering` | CassandraIndexSearcher.`makeIndexClustering(java.nio.ByteBuffer rowKey, Clustering clustering)`

    Methods in org.apache.cassandra.index.internal with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `void` | CassandraIndex.`deleteStaleEntry(DecoratedKey indexKey, Clustering indexClustering, DeletionTime deletion, OpOrder.Group opGroup)` Specific to internal indexes, this is called by a searcher when it encounters a stale entry in the index
    `protected abstract java.nio.ByteBuffer` | CassandraIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)` Extract the value to be inserted into the index from the components of the base data
    `protected Clustering` | CassandraIndexSearcher.`makeIndexClustering(java.nio.ByteBuffer rowKey, Clustering clustering)`

    Constructors in org.apache.cassandra.index.internal with parameters of type Clustering
    Constructor and Description
    `IndexEntry(DecoratedKey indexValue, Clustering indexClustering, long timestamp, java.nio.ByteBuffer indexedKey, Clustering indexedEntryClustering)`

  - ### Uses of Clustering in org.apache.cassandra.index.internal.composites

    Methods in org.apache.cassandra.index.internal.composites with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `java.nio.ByteBuffer` | ClusteringColumnIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`
    `java.nio.ByteBuffer` | CollectionEntryIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`
    `java.nio.ByteBuffer` | CollectionKeyIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`
    `java.nio.ByteBuffer` | CollectionValueIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`
    `java.nio.ByteBuffer` | PartitionKeyIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`
    `java.nio.ByteBuffer` | RegularColumnIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`

  - ### Uses of Clustering in org.apache.cassandra.index.internal.keys

    Methods in org.apache.cassandra.index.internal.keys with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `protected java.nio.ByteBuffer` | KeysIndex.`getIndexedValue(java.nio.ByteBuffer partitionKey, Clustering clustering, CellPath path, java.nio.ByteBuffer cellValue)`

  - ### Uses of Clustering in org.apache.cassandra.service.pager

    Methods in org.apache.cassandra.service.pager that return Clustering
    Modifier and Type | Method and Description
    --- | ---
    `Clustering` | PagingState.RowMark.`clustering(CFMetaData metadata)`

    Methods in org.apache.cassandra.service.pager with parameters of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `protected QueryPager` | AggregationQueryPager.GroupByPartitionIterator.`updatePagerLimit(QueryPager pager, DataLimits limits, java.nio.ByteBuffer lastPartitionKey, Clustering lastClustering)` Updates the pager with the new limits if needed.
    `protected QueryPager` | AggregationQueryPager.AggregationPartitionIterator.`updatePagerLimit(QueryPager pager, DataLimits limits, java.nio.ByteBuffer lastPartitionKey, Clustering lastClustering)`

  - ### Uses of Clustering in org.apache.cassandra.utils.memory

    Methods in org.apache.cassandra.utils.memory that return types with arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `abstract SearchIterator<Clustering,Row>` | EnsureOnHeap.`applyToPartition(SearchIterator<Clustering,Row> partition)`

    Method parameters in org.apache.cassandra.utils.memory with type arguments of type Clustering
    Modifier and Type | Method and Description
    --- | ---
    `abstract SearchIterator<Clustering,Row>` | EnsureOnHeap.`applyToPartition(SearchIterator<Clustering,Row> partition)`

Copyright © 2018 The Apache Software Foundation