Package org.apache.cassandra.io.sstable.format

Class SSTableReaderWithFilter

java.lang.Object

org.apache.cassandra.io.sstable.SSTable

org.apache.cassandra.io.sstable.format.SSTableReader

org.apache.cassandra.io.sstable.format.SSTableReaderWithFilter

All Implemented Interfaces:

Comparable<SSTableReader>, UnfilteredSource, RefCounted<SSTableReader>, SelfRefCounted<SSTableReader>

Direct Known Subclasses:

BigTableReader, BtiTableReader

public abstract class SSTableReaderWithFilter
extends SSTableReader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SSTableReaderWithFilter.Builder<R extends SSTableReaderWithFilter,B extends SSTableReaderWithFilter.Builder<R,B>>

Nested classes/interfaces inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

SSTableReader.IndexesBounds, SSTableReader.InstanceTidier, SSTableReader.OpenReason, SSTableReader.Operator, SSTableReader.PartitionPositionBounds, SSTableReader.UniqueIdentifier

Nested classes/interfaces inherited from class org.apache.cassandra.io.sstable.SSTable

SSTable.Owner

Nested classes/interfaces inherited from interface org.apache.cassandra.utils.concurrent.RefCounted

RefCounted.Tidy

Field Summary

Fields inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

bounds, dfile, first, firstKeyComparator, firstKeyOrdering, header, idComparator, idReverseComparator, instanceId, isSuspect, last, lastKeyComparator, maxDataAge, maxTimestampAscending, maxTimestampDescending, openReason, sizeComparator, sstableMetadata, UNIQUE_IDENTIFIER_FACTORY

Fields inherited from class org.apache.cassandra.io.sstable.SSTable

chunkCache, components, compression, descriptor, ioOptions, metadata, TOMBSTONE_HISTOGRAM_BIN_SIZE, TOMBSTONE_HISTOGRAM_SPOOL_SIZE, TOMBSTONE_HISTOGRAM_TTL_ROUND_SECONDS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SSTableReaderWithFilter(SSTableReaderWithFilter.Builder<?,?> builder, SSTable.Owner owner)

Method Summary

Modifier and Type	Method	Description
abstract SSTableReaderWithFilter	cloneAndReplace(IFilter filter)
long	getFilterOffHeapSize()
long	getFilterSerializedSize()
BloomFilterTracker	getFilterTracker()
protected boolean	isPresentInFilter(IFilter.FilterKey key)
boolean	mayContainAssumingKeyIsInRange(DecoratedKey key)	The method verifies whether the sstable may contain the provided key.
protected void	notifySelected(SSTableReadsListener.SelectionReason reason, SSTableReadsListener localListener, SSTableReader.Operator op, boolean updateStats, AbstractRowIndexEntry entry)	A method to be called by SSTableReader.getPosition(PartitionPosition, Operator, boolean, SSTableReadsListener) and SSTableReader.getRowIndexEntry(PartitionPosition, Operator, boolean, SSTableReadsListener) methods when a searched key is found.
protected void	notifySkipped(SSTableReadsListener.SkippingReason reason, SSTableReadsListener localListener, SSTableReader.Operator op, boolean updateStats)	A method to be called by SSTableReader.getPosition(PartitionPosition, Operator, boolean, SSTableReadsListener) and SSTableReader.getRowIndexEntry(PartitionPosition, Operator, boolean, SSTableReadsListener) methods when a searched key is not found.
protected List<AutoCloseable>	setupInstance(boolean trackHotness)
protected final <B extends SSTableReaderWithFilter.Builder<?, B>> B	unbuildTo(B builder, boolean sharedCopy)

Methods inherited from class org.apache.cassandra.io.sstable.format.SSTableReader

addTo, bytesOnDisk, cloneWithNewStart, cloneWithRestoredStart, closeInternalComponent, compareTo, createLinks, createLinks, createLinks, createLinks, equals, estimatedKeys, estimatedKeysForRanges, firstKeyBeyond, getApproximateKeyCount, getAvgColumnSetPerRow, getBounds, getCompressionMetadata, getCompressionMetadataOffHeapSize, getCompressionRatio, getCrcCheckChance, getDataChannel, getDataCreationTime, getDroppableTombstonesBefore, getEstimatedCellPerPartitionCount, getEstimatedDroppableTombstoneRatio, getEstimatedPartitionSize, getFileDataInput, getFilename, getFirst, getInterval, getKeySamples, getLast, getMaxLocalDeletionTime, getMaxTimestamp, getMaxTTL, getMinLocalDeletionTime, getMinTimestamp, getMinTTL, getPendingRepair, getPosition, getPosition, getPosition, getPosition, getPositionsForBounds, getPositionsForBoundsIterator, getPositionsForFullRange, getPositionsForRanges, getReadMeter, getRepairedAt, getRowIndexEntry, getScanner, getScanner, getScanner, getScanner, getSSTableLevel, getSSTableMetadata, getTotalBytes, getTotalColumnsSet, getTotalRows, getTotalUncompressedBytes, getVerifier, hashCode, incrementReadCount, instanceId, intersects, isEstimationInformative, isMarkedCompacted, isMarkedSuspect, isPendingRepair, isRepaired, isReplaced, isTransient, keyAtPositionFromSecondaryIndex, keyIterator, keyReader, logicalBytesOnDisk, markObsolete, markSuspect, maybeGetChecksumValidator, maybeGetDigestValidator, maybePersistSSTableReadMeter, mayHaveTombstones, moveAndOpenSSTable, mutateLevelAndReload, mutateRepairedAndReload, newSince, onDiskLength, onDiskSizeForPartitionPositions, open, open, open, open, openAll, openDataReader, openDataReader, openDataReaderForScan, openForBatch, openNoValidation, openNoValidation, overrideReadMeter, ref, releaseInMemoryComponents, reloadSSTableMetadata, resetTidying, runOnClose, runWithLock, selfRef, setCrcCheckChance, setReplaced, setup, setupOnline, shutdownBlocking, simpleIterator, stats, tokenSpaceCoverage, tryRef, trySkipFileCacheBefore, unbuildTo, uncompressedLength, unmarkSuspect, validate

Methods inherited from class org.apache.cassandra.io.sstable.SSTable

addComponents, copy, decorateKey, getAllFilePaths, getColumnFamilyName, getComponents, getId, getKeyspaceName, getPartitioner, getStreamingComponents, hardlink, metadata, owner, registerComponents, rename, toString, tryComponentFromFilename, tryComponentFromFilename, tryDescriptorFromFile, unbuildTo, unregisterComponents, validateRepairedMetadata

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cassandra.db.rows.UnfilteredSource

partitionIterator, rowIterator, rowIterator

Constructor Details

SSTableReaderWithFilter

protected SSTableReaderWithFilter(SSTableReaderWithFilter.Builder<?,?> builder,
 SSTable.Owner owner)

Method Details

setupInstance

protected List<AutoCloseable> setupInstance(boolean trackHotness)

Overrides:

setupInstance in class SSTableReader

unbuildTo

protected final <B extends SSTableReaderWithFilter.Builder<?,
B>>
B unbuildTo(B builder,
 boolean sharedCopy)

isPresentInFilter

protected boolean isPresentInFilter(IFilter.FilterKey key)

mayContainAssumingKeyIsInRange

public boolean mayContainAssumingKeyIsInRange(DecoratedKey key)

Description copied from class: SSTableReader

The method verifies whether the sstable may contain the provided key. The method does approximation using Bloom filter if it is present and if it is not, performs accurate check in the index.

Specified by:

mayContainAssumingKeyIsInRange in class SSTableReader

notifySelected

protected void notifySelected(SSTableReadsListener.SelectionReason reason,
 SSTableReadsListener localListener,
 SSTableReader.Operator op,
 boolean updateStats,
 AbstractRowIndexEntry entry)

Description copied from class: SSTableReader

A method to be called by SSTableReader.getPosition(PartitionPosition, Operator, boolean, SSTableReadsListener) and SSTableReader.getRowIndexEntry(PartitionPosition, Operator, boolean, SSTableReadsListener) methods when a searched key is found. It adds a trace message and notify the provided listener.

Overrides:

notifySelected in class SSTableReader

notifySkipped

protected void notifySkipped(SSTableReadsListener.SkippingReason reason,
 SSTableReadsListener localListener,
 SSTableReader.Operator op,
 boolean updateStats)

Description copied from class: SSTableReader

A method to be called by SSTableReader.getPosition(PartitionPosition, Operator, boolean, SSTableReadsListener) and SSTableReader.getRowIndexEntry(PartitionPosition, Operator, boolean, SSTableReadsListener) methods when a searched key is not found. It adds a trace message and notify the provided listener.

Overrides:

notifySkipped in class SSTableReader

getFilterTracker

public BloomFilterTracker getFilterTracker()

getFilterSerializedSize

public long getFilterSerializedSize()

getFilterOffHeapSize

public long getFilterOffHeapSize()

cloneAndReplace

public abstract SSTableReaderWithFilter cloneAndReplace(IFilter filter)