Uses of Class org.apache.cassandra.db.DecoratedKey (apache-cassandra API)
Date: 2014-10-21

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

- Packages that use DecoratedKey
  Package | Description
  --- | ---
  org.apache.cassandra.cache |
  org.apache.cassandra.db |
  org.apache.cassandra.db.columniterator |
  org.apache.cassandra.db.compaction |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.db.index |
  org.apache.cassandra.db.index.composites |
  org.apache.cassandra.dht |
  org.apache.cassandra.io.sstable |
  org.apache.cassandra.service |
  org.apache.cassandra.thrift |
  org.apache.cassandra.utils |
  org.apache.cassandra.utils.memory |

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

    Constructors in org.apache.cassandra.cache with parameters of type DecoratedKey
    Constructor and Description
    `RowCacheKey(java.util.UUID cfId, DecoratedKey key)`

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

    Subclasses of DecoratedKey in org.apache.cassandra.db
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BufferDecoratedKey`
    `class` | `NativeDecoratedKey`

    Fields in org.apache.cassandra.db declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `DecoratedKey` | Row.`key`

    Fields in org.apache.cassandra.db with type parameters of type DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `static java.util.Comparator<DecoratedKey>` | DecoratedKey.`comparator`

    Methods in org.apache.cassandra.db that return types with arguments of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<java.util.Map.Entry<DecoratedKey,ColumnFamily>>` | Memtable.`getEntryIterator(RowPosition startWith, RowPosition stopAt)`
    `static java.util.Map<DecoratedKey,ColumnFamily>` | SystemKeyspace.`getSchema(java.lang.String schemaCfName, java.util.Set<java.lang.String> keyspaces)`
    `java.lang.Iterable<DecoratedKey>` | ColumnFamilyStore.`keySamples(Range<Token> range)`

    Methods in org.apache.cassandra.db with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | ColumnFamilyStore.`apply(DecoratedKey key, ColumnFamily columnFamily, SecondaryIndexManager.Updater indexer, OpOrder.Group opGroup, ReplayPosition replayPosition)` Insert/Update the column family for this key.
    `boolean` | ColumnFamilyStore.`containsCachedRow(DecoratedKey key)`
    `ColumnFamily` | Memtable.`getColumnFamily(DecoratedKey key)`
    `ColumnFamily` | ColumnFamilyStore.`getColumnFamily(DecoratedKey key, Composite start, Composite finish, boolean reversed, int limit, long timestamp)`
    `ColumnFamily` | ColumnFamilyStore.`getRawCachedRow(DecoratedKey key)`
    `static void` | Keyspace.`indexRow(DecoratedKey key, ColumnFamilyStore cfs, java.util.Set<java.lang.String> idxNames)`
    `void` | ColumnFamilyStore.`invalidateCachedRow(DecoratedKey key)`
    `void` | ColumnFamilyStore.`maybeUpdateRowCache(DecoratedKey key)`
    `com.google.common.base.Function<DataTracker.View,java.util.List<SSTableReader>>` | ColumnFamilyStore.`viewFilter(DecoratedKey key)`

    Constructors in org.apache.cassandra.db with parameters of type DecoratedKey
    Constructor and Description
    `Row(DecoratedKey key, ColumnFamily cf)`

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

    Fields in org.apache.cassandra.db.columniterator declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `DecoratedKey` | SSTableNamesIterator.`key`

    Methods in org.apache.cassandra.db.columniterator that return DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `DecoratedKey` | LazyColumnIterator.`getKey()`
    `DecoratedKey` | OnDiskAtomIterator.`getKey()`
    `DecoratedKey` | SSTableNamesIterator.`getKey()`
    `DecoratedKey` | SSTableSliceIterator.`getKey()`

    Constructors in org.apache.cassandra.db.columniterator with parameters of type DecoratedKey
    Constructor and Description
    `LazyColumnIterator(DecoratedKey key, IColumnIteratorFactory subIteratorFactory)`
    `SSTableNamesIterator(SSTableReader sstable, DecoratedKey key, java.util.SortedSet<CellName> columns)`
    `SSTableNamesIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, java.util.SortedSet<CellName> columns, RowIndexEntry indexEntry)`
    `SSTableSliceIterator(SSTableReader sstable, DecoratedKey key, ColumnSlice[] slices, boolean reversed)`
    `SSTableSliceIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, ColumnSlice[] slices, boolean reversed, RowIndexEntry indexEntry)` An iterator for a slice within an SSTable

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

    Fields in org.apache.cassandra.db.compaction declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `DecoratedKey` | AbstractCompactedRow.`key`

    Methods in org.apache.cassandra.db.compaction with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompactionController.`invalidateCachedRow(DecoratedKey key)`
    `long` | CompactionController.`maxPurgeableTimestamp(DecoratedKey key)`
    `long` | SSTableSplitter.SplitController.`maxPurgeableTimestamp(DecoratedKey key)`

    Constructors in org.apache.cassandra.db.compaction with parameters of type DecoratedKey
    Constructor and Description
    `AbstractCompactedRow(DecoratedKey key)`

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

    Fields in org.apache.cassandra.db.filter declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `DecoratedKey` | QueryFilter.`key`

    Methods in org.apache.cassandra.db.filter with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `OnDiskAtomIterator` | IDiskAtomFilter.`getColumnIterator(DecoratedKey key, ColumnFamily cf)`
    `OnDiskAtomIterator` | NamesQueryFilter.`getColumnIterator(DecoratedKey key, ColumnFamily cf)`
    `OnDiskAtomIterator` | SliceQueryFilter.`getColumnIterator(DecoratedKey key, ColumnFamily cf)`
    `abstract IDiskAtomFilter` | ExtendedFilter.`getExtraFilter(DecoratedKey key, ColumnFamily data)` Returns a filter to query the columns from the clause that the initial slice filter may not have caught.
    `IDiskAtomFilter` | ExtendedFilter.WithClauses.`getExtraFilter(DecoratedKey rowKey, ColumnFamily data)`
    `static QueryFilter` | QueryFilter.`getIdentityFilter(DecoratedKey key, java.lang.String cfName, long timestamp)` return a QueryFilter object that includes every column in the row.
    `static QueryFilter` | QueryFilter.`getNamesFilter(DecoratedKey key, java.lang.String cfName, java.util.SortedSet<CellName> columns, long timestamp)`
    `static QueryFilter` | QueryFilter.`getSliceFilter(DecoratedKey key, java.lang.String cfName, Composite start, Composite finish, boolean reversed, int limit, long timestamp)`
    `OnDiskAtomIterator` | IDiskAtomFilter.`getSSTableColumnIterator(SSTableReader sstable, DecoratedKey key)` returns an iterator that returns columns from the given SSTable matching the Filter criteria in sorted order.
    `OnDiskAtomIterator` | NamesQueryFilter.`getSSTableColumnIterator(SSTableReader sstable, DecoratedKey key)`
    `OnDiskAtomIterator` | SliceQueryFilter.`getSSTableColumnIterator(SSTableReader sstable, DecoratedKey key)`
    `OnDiskAtomIterator` | IDiskAtomFilter.`getSSTableColumnIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry)` Get an iterator that returns columns from the given SSTable using the opened file matching the Filter criteria in sorted order.
    `OnDiskAtomIterator` | NamesQueryFilter.`getSSTableColumnIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry)`
    `OnDiskAtomIterator` | SliceQueryFilter.`getSSTableColumnIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry)`
    `abstract boolean` | ExtendedFilter.`isSatisfiedBy(DecoratedKey rowKey, ColumnFamily data, Composite prefix, java.nio.ByteBuffer collectionElement)`
    `boolean` | ExtendedFilter.WithClauses.`isSatisfiedBy(DecoratedKey rowKey, ColumnFamily data, Composite prefix, java.nio.ByteBuffer collectionElement)`
    `abstract ColumnFamily` | ExtendedFilter.`prune(DecoratedKey key, ColumnFamily data)`
    `ColumnFamily` | ExtendedFilter.WithClauses.`prune(DecoratedKey rowKey, ColumnFamily data)`

    Constructors in org.apache.cassandra.db.filter with parameters of type DecoratedKey
    Constructor and Description
    `QueryFilter(DecoratedKey key, java.lang.String cfName, IDiskAtomFilter filter, long timestamp)`

  - ### Uses of DecoratedKey in org.apache.cassandra.db.index

    Methods in org.apache.cassandra.db.index that return DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `DecoratedKey` | AbstractSimplePerColumnSecondaryIndex.`getIndexKeyFor(java.nio.ByteBuffer value)`
    `DecoratedKey` | SecondaryIndex.`getIndexKeyFor(java.nio.ByteBuffer value)` Returns the decoratedKey for a column value

    Methods in org.apache.cassandra.db.index with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | PerRowSecondaryIndex.`delete(DecoratedKey key, OpOrder.Group opGroup)` cleans up deleted columns from cassandra cleanup compaction
    `void` | SecondaryIndexManager.`deleteFromIndexes(DecoratedKey key, java.util.List<Cell> indexedColumnsInRow, OpOrder.Group opGroup)` Delete all columns from all indexes for this row.
    `SecondaryIndexManager.Updater` | SecondaryIndexManager.`gcUpdaterFor(DecoratedKey key)` Updated closure with only the modified row key.
    `SecondaryIndexManager.Updater` | SecondaryIndexManager.`updaterFor(DecoratedKey key, ColumnFamily cf, OpOrder.Group opGroup)` This helper acts as a closure around the indexManager and updated cf data to ensure that down in Memtable's ColumnFamily implementation, the index can get updated.

  - ### Uses of DecoratedKey in org.apache.cassandra.db.index.composites

    Fields in org.apache.cassandra.db.index.composites declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `DecoratedKey` | CompositesIndex.IndexedEntry.`indexValue`

    Methods in org.apache.cassandra.db.index.composites with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `abstract CompositesIndex.IndexedEntry` | CompositesIndex.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`
    `CompositesIndex.IndexedEntry` | CompositesIndexOnClusteringKey.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`
    `CompositesIndex.IndexedEntry` | CompositesIndexOnCollectionKey.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`
    `CompositesIndex.IndexedEntry` | CompositesIndexOnCollectionValue.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`
    `CompositesIndex.IndexedEntry` | CompositesIndexOnPartitionKey.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`
    `CompositesIndex.IndexedEntry` | CompositesIndexOnRegular.`decodeEntry(DecoratedKey indexedValue, Cell indexEntry)`

    Constructors in org.apache.cassandra.db.index.composites with parameters of type DecoratedKey
    Constructor and Description
    `CompositesIndex.IndexedEntry(DecoratedKey indexValue, CellName indexEntry, long timestamp, java.nio.ByteBuffer indexedKey, Composite indexedEntryPrefix)`
    `CompositesIndex.IndexedEntry(DecoratedKey indexValue, CellName indexEntry, long timestamp, java.nio.ByteBuffer indexedKey, Composite indexedEntryPrefix, java.nio.ByteBuffer indexedEntryCollectionKey)`

  - ### Uses of DecoratedKey in org.apache.cassandra.dht

    Methods in org.apache.cassandra.dht that return DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `DecoratedKey` | AbstractByteOrderedPartitioner.`decorateKey(java.nio.ByteBuffer key)`
    `DecoratedKey` | IPartitioner.`decorateKey(java.nio.ByteBuffer key)` Transform key to object representation of the on-disk format.
    `DecoratedKey` | LocalPartitioner.`decorateKey(java.nio.ByteBuffer key)`
    `DecoratedKey` | Murmur3Partitioner.`decorateKey(java.nio.ByteBuffer key)`
    `DecoratedKey` | OrderPreservingPartitioner.`decorateKey(java.nio.ByteBuffer key)`
    `DecoratedKey` | RandomPartitioner.`decorateKey(java.nio.ByteBuffer key)`

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

    Fields in org.apache.cassandra.io.sstable declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `protected DecoratedKey` | AbstractSSTableSimpleWriter.`currentKey`
    `DecoratedKey` | SSTable.`first`
    `DecoratedKey` | SSTable.`last`

    Methods in org.apache.cassandra.io.sstable that return DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `protected DecoratedKey` | KeyIterator.`computeNext()`
    `DecoratedKey` | SSTableReader.`firstKeyBeyond(RowPosition token)` Finds and returns the first key beyond a given token in this SSTable or null if no such key exists.
    `DecoratedKey` | SSTableIdentityIterator.`getKey()`
    `DecoratedKey` | IndexSummaryBuilder.`getMaxReadableKey(long position, int offset)`
    `static DecoratedKey` | SSTable.`getMinimalKey(DecoratedKey key)` If the given @param key occupies only part of a larger buffer, allocate a new buffer that is only as large as necessary.
    `DecoratedKey` | ReducingKeyIterator.`next()`

    Methods in org.apache.cassandra.io.sstable that return types with arguments of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Iterable<DecoratedKey>` | SSTableReader.`getKeySamples(Range<Token> range)`

    Methods in org.apache.cassandra.io.sstable with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `void` | SSTableWriter.`append(DecoratedKey decoratedKey, ColumnFamily cf)`
    `long` | SSTableWriter.`appendFromStream(DecoratedKey key, CFMetaData metadata, java.io.DataInput in, Descriptor.Version version)`
    `IndexSummary` | IndexSummaryBuilder.`build(IPartitioner partitioner, DecoratedKey exclusiveUpperBound)`
    `void` | SSTableReader.`cacheKey(DecoratedKey key, RowIndexEntry info)`
    `SSTableReader` | SSTableReader.`cloneWithNewStart(DecoratedKey newStart, java.lang.Runnable runOnClose)`
    `RowIndexEntry` | SSTableReader.`getCachedPosition(DecoratedKey key, boolean updateStats)`
    `static DecoratedKey` | SSTable.`getMinimalKey(DecoratedKey key)` If the given @param key occupies only part of a larger buffer, allocate a new buffer that is only as large as necessary.
    `void` | SSTableReader.`invalidateCacheKey(DecoratedKey key)`
    `IndexSummaryBuilder` | IndexSummaryBuilder.`maybeAddEntry(DecoratedKey decoratedKey, long indexPosition)`
    `static RowIndexEntry` | SSTableWriter.`rawAppend(ColumnFamily cf, long startPosition, DecoratedKey key, DataOutputPlus out)`
    `protected abstract void` | AbstractSSTableSimpleWriter.`writeRow(DecoratedKey key, ColumnFamily columnFamily)`
    `protected void` | SSTableSimpleUnsortedWriter.`writeRow(DecoratedKey key, ColumnFamily columnFamily)`
    `protected void` | SSTableSimpleWriter.`writeRow(DecoratedKey key, ColumnFamily columnFamily)`

    Constructors in org.apache.cassandra.io.sstable with parameters of type DecoratedKey
    Constructor and Description
    `SSTableIdentityIterator(SSTableReader sstable, RandomAccessReader file, DecoratedKey key, long dataSize)` Used to iterate through the columns of a row.
    `SSTableIdentityIterator(SSTableReader sstable, RandomAccessReader file, DecoratedKey key, long dataSize, boolean checkData)` Used to iterate through the columns of a row.

  - ### Uses of DecoratedKey in org.apache.cassandra.service

    Fields in org.apache.cassandra.service declared as DecoratedKey
    Modifier and Type | Field and Description
    --- | ---
    `protected DecoratedKey` | AbstractRowResolver.`key`

    Methods in org.apache.cassandra.service with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `static java.util.List<AsyncOneResponse>` | RowDataResolver.`scheduleRepairs(ColumnFamily resolved, java.lang.String keyspaceName, DecoratedKey key, java.util.List<ColumnFamily> versions, java.util.List<java.net.InetAddress> endpoints)` For each row version, compare with resolved (the superset of all row versions); if it is missing anything, send a mutation to the endpoint it come from.

    Constructors in org.apache.cassandra.service with parameters of type DecoratedKey
    Constructor and Description
    `DigestMismatchException(DecoratedKey key, java.nio.ByteBuffer digest1, java.nio.ByteBuffer digest2)`

  - ### Uses of DecoratedKey in org.apache.cassandra.thrift

    Methods in org.apache.cassandra.thrift that return types with arguments of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `protected java.util.Map<DecoratedKey,ColumnFamily>` | CassandraServer.`readColumnFamily(java.util.List<ReadCommand> commands, ConsistencyLevel consistency_level)`

  - ### Uses of DecoratedKey in org.apache.cassandra.utils

    Method parameters in org.apache.cassandra.utils with type arguments of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `static void` | FBUtilities.`sortSampledKeys(java.util.List<DecoratedKey> keys, Range<Token> range)`

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

    Methods in org.apache.cassandra.utils.memory that return DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `abstract DecoratedKey` | MemtableAllocator.`clone(DecoratedKey key, OpOrder.Group opGroup)`
    `DecoratedKey` | MemtableBufferAllocator.`clone(DecoratedKey key, OpOrder.Group writeOp)`
    `DecoratedKey` | NativeAllocator.`clone(DecoratedKey key, OpOrder.Group writeOp)`

    Methods in org.apache.cassandra.utils.memory with parameters of type DecoratedKey
    Modifier and Type | Method and Description
    --- | ---
    `abstract DecoratedKey` | MemtableAllocator.`clone(DecoratedKey key, OpOrder.Group opGroup)`
    `DecoratedKey` | MemtableBufferAllocator.`clone(DecoratedKey key, OpOrder.Group writeOp)`
    `DecoratedKey` | NativeAllocator.`clone(DecoratedKey key, OpOrder.Group writeOp)`
    `MemtableAllocator.DataReclaimer` | MemtableAllocator.DataReclaimer.`reclaimImmediately(DecoratedKey key)`

Copyright © 2014 The Apache Software Foundation