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

## Uses of Interface
org.apache.cassandra.db.filter.ClusteringIndexFilter

- Packages that use ClusteringIndexFilter
  Package | Description
  --- | ---
  org.apache.cassandra.db |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.db.rows |
  org.apache.cassandra.service.pager |

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

    Fields in org.apache.cassandra.db declared as ClusteringIndexFilter
    Modifier and Type | Field and Description
    --- | ---
    `protected ClusteringIndexFilter` | DataRange.`clusteringIndexFilter`

    Methods in org.apache.cassandra.db that return ClusteringIndexFilter
    Modifier and Type | Method and Description
    --- | ---
    `ClusteringIndexFilter` | SinglePartitionReadCommand.`clusteringIndexFilter()`
    `ClusteringIndexFilter` | DataRange.`clusteringIndexFilter(DecoratedKey key)` The clustering index filter to use for the provided key.
    `ClusteringIndexFilter` | DataRange.Paging.`clusteringIndexFilter(DecoratedKey key)`
    `ClusteringIndexFilter` | PartitionRangeReadCommand.`clusteringIndexFilter(DecoratedKey key)`
    `abstract ClusteringIndexFilter` | ReadCommand.`clusteringIndexFilter(DecoratedKey key)` The clustering index filter this command to use for the provided key.
    `ClusteringIndexFilter` | SinglePartitionReadCommand.`clusteringIndexFilter(DecoratedKey key)`
    `protected ClusteringIndexFilter` | AbstractReadCommandBuilder.`makeFilter()`
    `protected ClusteringIndexFilter` | AbstractReadCommandBuilder.SinglePartitionSliceBuilder.`makeFilter()`

    Methods in org.apache.cassandra.db with parameters of type ClusteringIndexFilter
    Modifier and Type | Method and Description
    --- | ---
    `static DataRange` | DataRange.`allData(IPartitioner partitioner, ClusteringIndexFilter filter)` Creates a `DataRange` to query all partitions of the ring using the provided clustering index filter.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter, IndexMetadata indexMetadata)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, DecoratedKey key, ColumnFilter columnFilter, ClusteringIndexFilter filter)` Creates a new read command on a single partition.
    `boolean` | ColumnFamilyStore.`isFilterFullyCoveredBy(ClusteringIndexFilter filter, DataLimits limits, CachedPartition cached, int nowInSec)`
    `UnfilteredRowIteratorWithLowerBound` | StorageHook.`makeRowIteratorWithLowerBound(ColumnFamilyStore cfs, DecoratedKey partitionKey, SSTableReader sstable, ClusteringIndexFilter filter, ColumnFilter selectedColumns, boolean isForThrift, int nowInSec, boolean applyThriftTransformation, SSTableReadsListener listener)`
    `SinglePartitionReadCommand` | SinglePartitionReadCommand.`withUpdatedClusteringIndexFilter(ClusteringIndexFilter filter)`

    Constructors in org.apache.cassandra.db with parameters of type ClusteringIndexFilter
    Constructor and Description
    `DataRange(AbstractBounds<PartitionPosition> range, ClusteringIndexFilter clusteringIndexFilter)` Creates a `DataRange` given a range of partition keys and a clustering index filter.

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

    Classes in org.apache.cassandra.db.filter that implement ClusteringIndexFilter
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractClusteringIndexFilter`
    `class` | `ClusteringIndexNamesFilter` A filter selecting rows given their clustering value.
    `class` | `ClusteringIndexSliceFilter` A filter over a single partition.

    Methods in org.apache.cassandra.db.filter that return ClusteringIndexFilter
    Modifier and Type | Method and Description
    --- | ---
    `ClusteringIndexFilter` | ClusteringIndexFilter.Serializer.`deserialize(DataInputPlus in, int version, CFMetaData metadata)`
    `ClusteringIndexFilter` | ClusteringIndexFilter.InternalDeserializer.`deserialize(DataInputPlus in, int version, CFMetaData metadata, boolean reversed)`
    `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.

    Methods in org.apache.cassandra.db.filter with parameters of type ClusteringIndexFilter
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClusteringIndexFilter.Serializer.`serialize(ClusteringIndexFilter filter, DataOutputPlus out, int version)`
    `long` | ClusteringIndexFilter.Serializer.`serializedSize(ClusteringIndexFilter filter, int version)`

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

    Constructors in org.apache.cassandra.db.rows with parameters of type ClusteringIndexFilter
    Constructor and Description
    `UnfilteredRowIteratorWithLowerBound(DecoratedKey partitionKey, SSTableReader sstable, ClusteringIndexFilter filter, ColumnFilter selectedColumns, boolean isForThrift, int nowInSec, boolean applyThriftTransformation, SSTableReadsListener listener)`

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

    Methods in org.apache.cassandra.service.pager with parameters of type ClusteringIndexFilter
    Modifier and Type | Method and Description
    --- | ---
    `static int` | QueryPagers.`countPaged(CFMetaData metadata, DecoratedKey key, ColumnFilter columnFilter, ClusteringIndexFilter filter, DataLimits limits, ConsistencyLevel consistencyLevel, ClientState state, int pageSize, int nowInSec, boolean isForThrift, long queryStartNanoTime)` Convenience method that count (live) cells/rows for a given slice of a row, but page underneath.

Copyright © 2018 The Apache Software Foundation