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

## Uses of Class
org.apache.cassandra.db.ClusteringComparator

- Packages that use ClusteringComparator
  Package | Description
  --- | ---
  org.apache.cassandra.config |
  org.apache.cassandra.cql3 |
  org.apache.cassandra.db |
  org.apache.cassandra.db.aggregation |
  org.apache.cassandra.db.columniterator |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.index.internal |
  org.apache.cassandra.io.sstable.metadata |

- - ### Uses of ClusteringComparator in org.apache.cassandra.config

    Fields in org.apache.cassandra.config declared as ClusteringComparator
    Modifier and Type | Field and Description
    --- | ---
    `ClusteringComparator` | CFMetaData.`comparator`

    Methods in org.apache.cassandra.config that return ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `ClusteringComparator` | CFMetaData.`getKeyValidatorAsClusteringComparator()`

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

    Methods in org.apache.cassandra.cql3 with parameters of type ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `RangeTombstone` | UpdateParameters.`makeRangeTombstone(ClusteringComparator comparator, Clustering clustering)`

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

    Fields in org.apache.cassandra.db declared as ClusteringComparator
    Modifier and Type | Field and Description
    --- | ---
    `protected ClusteringComparator` | MultiCBuilder.`comparator` The table comparator.
    `ClusteringComparator` | Memtable.`initialComparator`

    Methods in org.apache.cassandra.db that return ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `abstract ClusteringComparator` | CBuilder.`comparator()`
    `ClusteringComparator` | RangeTombstoneList.`comparator()`
    `ClusteringComparator` | ColumnFamilyStore.`getComparator()`

    Methods in org.apache.cassandra.db with parameters of type ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `void` | MutableDeletionInfo.`add(RangeTombstone tombstone, ClusteringComparator comparator)`
    `static MutableDeletionInfo.Builder` | MutableDeletionInfo.`builder(DeletionTime partitionLevelDeletion, ClusteringComparator comparator, boolean reversed)`
    `static CBuilder` | CBuilder.`create(ClusteringComparator comparator)`
    `static MultiCBuilder` | MultiCBuilder.`create(ClusteringComparator comparator, boolean forMultipleValues)` Creates a new empty `MultiCBuilder`.
    `static ClusteringBound` | ClusteringBound.`create(ClusteringComparator comparator, boolean isStart, boolean isInclusive, java.lang.Object... values)`
    `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.
    `boolean` | Slice.`includes(ClusteringComparator comparator, ClusteringPrefix bound)` Returns whether a given clustering or bound is included in this slice.
    `boolean` | Slice.`intersects(ClusteringComparator comparator, java.util.List<java.nio.ByteBuffer> minClusteringValues, java.util.List<java.nio.ByteBuffer> maxClusteringValues)` Given the per-clustering column minimum and maximum value a sstable contains, whether or not this slice potentially intersects that sstable or not.
    `boolean` | ClusteringComparator.`isCompatibleWith(ClusteringComparator previous)` Returns whether this clustering comparator is compatible with the provided one, that is if the provided one can be safely replaced by this new one.
    `boolean` | Slice.`isEmpty(ClusteringComparator comparator)` Return whether the slice is empty.
    `static boolean` | Slice.`isEmpty(ClusteringComparator comparator, ClusteringBound start, ClusteringBound end)` Return whether the slice formed by the two provided bound is empty or not.
    `static Slice` | Slice.`make(ClusteringComparator comparator, java.lang.Object... values)`
    `java.lang.String` | ClusteringBoundOrBoundary.`toString(ClusteringComparator comparator)`
    `java.lang.String` | RangeTombstone.`toString(ClusteringComparator comparator)`
    `java.lang.String` | Slice.`toString(ClusteringComparator comparator)`
    `static Slices` | Slices.`with(ClusteringComparator comparator, Slice slice)` Creates a `Slices` object that contains a single slice.

    Constructors in org.apache.cassandra.db with parameters of type ClusteringComparator
    Constructor and Description
    `Builder(ClusteringComparator comparator)`
    `Builder(ClusteringComparator comparator, int initialSize)`
    `Deserializer(ClusteringComparator comparator, DataInputPlus in, SerializationHeader header)`
    `MultiCBuilder(ClusteringComparator comparator)`
    `RangeTombstoneList(ClusteringComparator comparator, int capacity)`

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

    Methods in org.apache.cassandra.db.aggregation with parameters of type ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `static AggregationSpecification` | AggregationSpecification.`aggregatePkPrefix(ClusteringComparator comparator, int clusteringPrefixSize)` Creates a new `AggregationSpecification` instance that will build aggregates based on primary key columns.
    `AggregationSpecification` | AggregationSpecification.Serializer.`deserialize(DataInputPlus in, int version, ClusteringComparator comparator)`
    `GroupingState` | GroupingState.Serializer.`deserialize(DataInputPlus in, int version, ClusteringComparator comparator)`
    `static GroupMaker` | GroupMaker.`newInstance(ClusteringComparator comparator, int clusteringPrefixSize)`
    `static GroupMaker` | GroupMaker.`newInstance(ClusteringComparator comparator, int clusteringPrefixSize, GroupingState state)`
    `void` | GroupingState.Serializer.`serialize(GroupingState state, DataOutputPlus out, int version, ClusteringComparator comparator)`
    `long` | GroupingState.Serializer.`serializedSize(GroupingState state, int version, ClusteringComparator comparator)`

  - ### Uses of ClusteringComparator in org.apache.cassandra.db.columniterator

    Constructors in org.apache.cassandra.db.columniterator with parameters of type ClusteringComparator
    Constructor and Description
    `IndexState(AbstractSSTableIterator.Reader reader, ClusteringComparator comparator, RowIndexEntry indexEntry, boolean reversed, FileHandle indexFile)`

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

    Methods in org.apache.cassandra.db.filter with parameters of type ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `DataLimits` | DataLimits.Serializer.`deserialize(DataInputPlus in, int version, ClusteringComparator comparator)`
    `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)`
    `void` | DataLimits.Serializer.`serialize(DataLimits limits, DataOutputPlus out, int version, ClusteringComparator comparator)`
    `long` | DataLimits.Serializer.`serializedSize(DataLimits limits, int version, ClusteringComparator comparator)`

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

    Methods in org.apache.cassandra.index.internal that return ClusteringComparator
    Modifier and Type | Method and Description
    --- | ---
    `ClusteringComparator` | CassandraIndex.`getIndexComparator()`

  - ### Uses of ClusteringComparator in org.apache.cassandra.io.sstable.metadata

    Constructors in org.apache.cassandra.io.sstable.metadata with parameters of type ClusteringComparator
    Constructor and Description
    `MetadataCollector(ClusteringComparator comparator)`
    `MetadataCollector(java.lang.Iterable<SSTableReader> sstables, ClusteringComparator comparator, int level)`

Copyright © 2018 The Apache Software Foundation