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

## Uses of Interface
org.apache.cassandra.index.Index

- Packages that use Index
  Package | Description
  --- | ---
  org.apache.cassandra.cql3.restrictions |
  org.apache.cassandra.db |
  org.apache.cassandra.db.compaction |
  org.apache.cassandra.index |
  org.apache.cassandra.index.internal |
  org.apache.cassandra.index.internal.composites |
  org.apache.cassandra.index.internal.keys |
  org.apache.cassandra.index.sasi |
  org.apache.cassandra.io.sstable |
  org.apache.cassandra.io.sstable.format |

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

    Methods in org.apache.cassandra.cql3.restrictions with parameters of type Index
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | TermSlice.`isSupportedBy(ColumnDefinition column, Index index)` Check if this `TermSlice` is supported by the specified index.
    `protected abstract boolean` | MultiColumnRestriction.`isSupportedBy(Index index)` Check if this type of restriction is supported for by the specified index.
    `protected boolean` | MultiColumnRestriction.EQRestriction.`isSupportedBy(Index index)`
    `protected boolean` | MultiColumnRestriction.INRestriction.`isSupportedBy(Index index)`
    `protected boolean` | MultiColumnRestriction.SliceRestriction.`isSupportedBy(Index index)`
    `protected boolean` | MultiColumnRestriction.NotNullRestriction.`isSupportedBy(Index index)`
    `protected abstract boolean` | SingleColumnRestriction.`isSupportedBy(Index index)` Check if this type of restriction is supported by the specified index.
    `protected boolean` | SingleColumnRestriction.EQRestriction.`isSupportedBy(Index index)`
    `protected boolean` | SingleColumnRestriction.INRestriction.`isSupportedBy(Index index)`
    `protected boolean` | SingleColumnRestriction.SliceRestriction.`isSupportedBy(Index index)`
    `protected boolean` | SingleColumnRestriction.ContainsRestriction.`isSupportedBy(Index index)`
    `protected boolean` | SingleColumnRestriction.IsNotNullRestriction.`isSupportedBy(Index index)`
    `protected boolean` | SingleColumnRestriction.LikeRestriction.`isSupportedBy(Index index)`

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

    Methods in org.apache.cassandra.db that return Index
    Modifier and Type | Method and Description
    --- | ---
    `Index` | ReadCommand.`getIndex(ColumnFamilyStore cfs)`

  - ### Uses of Index in org.apache.cassandra.db.compaction

    Method parameters in org.apache.cassandra.db.compaction with type arguments of type Index
    Modifier and Type | Method and Description
    --- | ---
    `SSTableMultiWriter` | AbstractCompactionStrategy.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, MetadataCollector meta, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `SSTableMultiWriter` | CompactionStrategyManager.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, MetadataCollector collector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`

  - ### Uses of Index in org.apache.cassandra.index

    Methods in org.apache.cassandra.index that return Index
    Modifier and Type | Method and Description
    --- | ---
    `Index` | SecondaryIndexManager.`getBestIndexFor(RowFilter rowFilter)` Called at query time to choose which (if any) of the registered index implementations to use for a given query.
    `Index` | IndexRegistry.`getIndex(IndexMetadata indexMetadata)`
    `Index` | SecondaryIndexManager.`getIndex(IndexMetadata metadata)`
    `Index` | SecondaryIndexManager.`getIndexByName(java.lang.String indexName)`

    Methods in org.apache.cassandra.index that return types with arguments of type Index
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Optional<Index>` | SecondaryIndexManager.`getBestIndexFor(RowFilter.Expression expression)`
    `java.util.Collection<Index>` | IndexRegistry.`listIndexes()`
    `java.util.Collection<Index>` | SecondaryIndexManager.`listIndexes()`

    Methods in org.apache.cassandra.index with parameters of type Index
    Modifier and Type | Method and Description
    --- | ---
    `void` | SecondaryIndexManager.`buildIndexBlocking(Index index)`
    `boolean` | SecondaryIndexManager.`isIndexQueryable(Index index)` Checks if the specified index is queryable.
    `void` | IndexRegistry.`registerIndex(Index index)`
    `void` | SecondaryIndexManager.`registerIndex(Index index)` IndexRegistry methods
    `void` | IndexRegistry.`unregisterIndex(Index index)`
    `void` | SecondaryIndexManager.`unregisterIndex(Index index)`

    Method parameters in org.apache.cassandra.index with type arguments of type Index
    Modifier and Type | Method and Description
    --- | ---
    `void` | SecondaryIndexManager.`flushIndexesBlocking(java.util.Set<Index> indexes)` Perform a blocking flush of selected indexes
    `SecondaryIndexBuilder` | Index.IndexBuildingSupport.`getIndexBuildTask(ColumnFamilyStore cfs, java.util.Set<Index> indexes, java.util.Collection<SSTableReader> sstables)`
    `SecondaryIndexBuilder` | Index.CollatedViewIndexBuildingSupport.`getIndexBuildTask(ColumnFamilyStore cfs, java.util.Set<Index> indexes, java.util.Collection<SSTableReader> sstables)`
    `void` | SecondaryIndexManager.`indexPartition(DecoratedKey key, java.util.Set<Index> indexes, int pageSize)` When building an index against existing data in sstables, add the given partition to the index

    Constructors in org.apache.cassandra.index with parameters of type Index
    Constructor and Description
    `IndexNotAvailableException(Index index)` Creates a new `IndexNotAvailableException` for the specified index.

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

    Classes in org.apache.cassandra.index.internal that implement Index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CassandraIndex` Index implementation which indexes the values for a single column in the base table and which stores its index data in a local, hidden table.

    Constructor parameters in org.apache.cassandra.index.internal with type arguments of type Index
    Constructor and Description
    `CollatedViewIndexBuilder(ColumnFamilyStore cfs, java.util.Set<Index> indexers, ReducingKeyIterator iter)`

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

    Classes in org.apache.cassandra.index.internal.composites that implement Index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ClusteringColumnIndex` Index on a CLUSTERING_COLUMN column definition.
    `class` | `CollectionEntryIndex` Index on the element and value of cells participating in a collection.
    `class` | `CollectionKeyIndex` Index on the collection element of the cell name of a collection.
    `class` | `CollectionKeyIndexBase` Common superclass for indexes that capture collection keys, including indexes on such keys themselves.
    `class` | `CollectionValueIndex` Index the value of a collection cell.
    `class` | `PartitionKeyIndex` Index on a PARTITION_KEY column definition.
    `class` | `RegularColumnIndex` Index on a REGULAR column definition on a composite type.

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

    Classes in org.apache.cassandra.index.internal.keys that implement Index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KeysIndex`

  - ### Uses of Index in org.apache.cassandra.index.sasi

    Classes in org.apache.cassandra.index.sasi that implement Index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SASIIndex`

  - ### Uses of Index in org.apache.cassandra.io.sstable

    Method parameters in org.apache.cassandra.io.sstable with type arguments of type Index
    Modifier and Type | Method and Description
    --- | ---
    `static SSTableTxnWriter` | SSTableTxnWriter.`create(CFMetaData cfm, Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes)`
    `static SSTableMultiWriter` | SimpleSSTableMultiWriter.`create(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData cfm, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`

  - ### Uses of Index in org.apache.cassandra.io.sstable.format

    Method parameters in org.apache.cassandra.io.sstable.format with type arguments of type Index
    Modifier and Type | Method and Description
    --- | ---
    `static SSTableWriter` | SSTableWriter.`create(CFMetaData metadata, Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, java.lang.Long keyCount, java.lang.Long repairedAt, CFMetaData metadata, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(java.lang.String filename, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(java.lang.String filename, long keyCount, long repairedAt, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`

Copyright © 2018 The Apache Software Foundation