StoreFile.Reader (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.StoreFile.Reader

Direct Known Subclasses:

HalfStoreFileReader

Enclosing class:

StoreFile
```
public static class StoreFile.Reader
extends Object
```
Reader for a StoreFile.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BloomType`	`bloomFilterType`
`private boolean`	`bulkLoadResult`
`protected BloomFilter`	`deleteFamilyBloomFilter`
`private long`	`deleteFamilyCnt`
`protected BloomFilter`	`generalBloomFilter`
`private byte[]`	`lastBloomKey`
`private static org.apache.commons.logging.Log`	`LOG`
`private HFile.Reader`	`reader`
`protected long`	`sequenceID`
`protected TimeRangeTracker`	`timeRangeTracker`

Constructor Summary

Constructors
Constructor and Description
`StoreFile.Reader()` ONLY USE DEFAULT CONSTRUCTOR FOR UNIT TESTS
`StoreFile.Reader(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, CacheConfig cacheConf, org.apache.hadoop.conf.Configuration conf)`
`StoreFile.Reader(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, FSDataInputStreamWrapper in, long size, CacheConfig cacheConf, org.apache.hadoop.conf.Configuration conf)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close(boolean evictOnClose)`
`(package private) void`	`disableBloomFilterForTesting()`
`BloomType`	`getBloomFilterType()`
`KeyValue.KVComparator`	`getComparator()`
`long`	`getDeleteFamilyCnt()`
`long`	`getEntries()`
`long`	`getFilterEntries()` The number of Bloom filter entries in this store file, or an estimate thereof, if the Bloom filter is not loaded.
`byte[]`	`getFirstKey()`
`(package private) BloomFilter`	`getGeneralBloomFilter()`
`int`	`getHFileMinorVersion()`
`HFile.Reader`	`getHFileReader()`
`int`	`getHFileVersion()`
`byte[]`	`getLastKey()`
`byte[]`	`getLastRowKey()`
`long`	`getMaxTimestamp()`
`HFileScanner`	`getScanner(boolean cacheBlocks, boolean pread)` Deprecated.
`HFileScanner`	`getScanner(boolean cacheBlocks, boolean pread, boolean isCompaction)` Deprecated.
`long`	`getSequenceID()`
`StoreFileScanner`	`getStoreFileScanner(boolean cacheBlocks, boolean pread)` Get a scanner to scan over this StoreFile.
`StoreFileScanner`	`getStoreFileScanner(boolean cacheBlocks, boolean pread, boolean isCompaction, long readPt)` Get a scanner to scan over this StoreFile.
`long`	`getTotalBloomSize()`
`long`	`getTotalUncompressedBytes()`
`(package private) long`	`getUncompressedDataIndexSize()`
`long`	`indexSize()`
`boolean`	`isBulkLoaded()`
`boolean`	`isPrimaryReplicaReader()`
`long`	`length()`
`void`	`loadBloomfilter()`
`private void`	`loadBloomfilter(BlockType blockType)`
`Map<byte[],byte[]>`	`loadFileInfo()`
`byte[]`	`midkey()`
`(package private) boolean`	`passesBloomFilter(Scan scan, SortedSet<byte[]> columns)` Checks whether the given scan passes the Bloom filter (if present).
`boolean`	`passesDeleteFamilyBloomFilter(byte[] row, int rowOffset, int rowLen)`
`boolean`	`passesGeneralBloomFilter(byte[] row, int rowOffset, int rowLen, byte[] col, int colOffset, int colLen)` A method for checking Bloom filters.
`boolean`	`passesKeyRangeFilter(Scan scan)` Checks whether the given scan rowkey range overlaps with the current storefile's
`(package private) boolean`	`passesTimerangeFilter(TimeRange timeRange, long oldestUnexpiredTS)` Check if this storeFile may contain keys within the TimeRange that have not expired (i.e.
`private void`	`setBloomFilterFaulty(BlockType blockType)`
`void`	`setBulkLoaded(boolean bulkLoadResult)`
`void`	`setDeleteFamilyBloomFilterFaulty()`
`void`	`setGeneralBloomFilterFaulty()`
`void`	`setReplicaStoreFile(boolean isPrimaryReplicaStoreFile)`
`void`	`setSequenceID(long sequenceID)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - generalBloomFilter
```
protected BloomFilter generalBloomFilter
```
  - deleteFamilyBloomFilter
```
protected BloomFilter deleteFamilyBloomFilter
```
  - bloomFilterType
```
protected BloomType bloomFilterType
```
  - reader
```
private final HFile.Reader reader
```
  - timeRangeTracker
```
protected TimeRangeTracker timeRangeTracker
```
  - sequenceID
```
protected long sequenceID
```
  - lastBloomKey
```
private byte[] lastBloomKey
```
  - deleteFamilyCnt
```
private long deleteFamilyCnt
```
  - bulkLoadResult
```
private boolean bulkLoadResult
```
- Constructor Detail
  - StoreFile.Reader
```
public StoreFile.Reader(org.apache.hadoop.fs.FileSystem fs,
                org.apache.hadoop.fs.Path path,
                CacheConfig cacheConf,
                org.apache.hadoop.conf.Configuration conf)
                 throws IOException
```
    Throws:
    
    IOException
  - StoreFile.Reader
```
public StoreFile.Reader(org.apache.hadoop.fs.FileSystem fs,
                org.apache.hadoop.fs.Path path,
                FSDataInputStreamWrapper in,
                long size,
                CacheConfig cacheConf,
                org.apache.hadoop.conf.Configuration conf)
                 throws IOException
```
    Throws:
    
    IOException
  - StoreFile.Reader
```
StoreFile.Reader()
```
    ONLY USE DEFAULT CONSTRUCTOR FOR UNIT TESTS
- Method Detail
  - setReplicaStoreFile
```
public void setReplicaStoreFile(boolean isPrimaryReplicaStoreFile)
```
  - isPrimaryReplicaReader
```
public boolean isPrimaryReplicaReader()
```
  - getComparator
```
public KeyValue.KVComparator getComparator()
```
  - getStoreFileScanner
```
public StoreFileScanner getStoreFileScanner(boolean cacheBlocks,
                                   boolean pread)
```
    Get a scanner to scan over this StoreFile. Do not use this overload if using this scanner for compactions.
    
    Parameters:
    cacheBlocks - should this scanner cache blocks?
    pread - use pread (for highly concurrent small readers)
    
    Returns:
    a scanner
  - getStoreFileScanner
```
public StoreFileScanner getStoreFileScanner(boolean cacheBlocks,
                                   boolean pread,
                                   boolean isCompaction,
                                   long readPt)
```
    Get a scanner to scan over this StoreFile.
    
    Parameters:
    cacheBlocks - should this scanner cache blocks?
    pread - use pread (for highly concurrent small readers)
    isCompaction - is scanner being used for compaction?
    
    Returns:
    a scanner
  - getScanner
```
@Deprecated
public HFileScanner getScanner(boolean cacheBlocks,
                                 boolean pread)
```
    Deprecated.
    
    Warning: Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts.
    
    Parameters:
    cacheBlocks - should we cache the blocks?
    pread - use pread (for concurrent small readers)
    
    Returns:
    the underlying HFileScanner
  - getScanner
```
@Deprecated
public HFileScanner getScanner(boolean cacheBlocks,
                                 boolean pread,
                                 boolean isCompaction)
```
    Deprecated.
    
    Warning: Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts.
    
    Parameters:
    cacheBlocks - should we cache the blocks?
    pread - use pread (for concurrent small readers)
    isCompaction - is scanner being used for compaction?
    
    Returns:
    the underlying HFileScanner
  - close
```
public void close(boolean evictOnClose)
           throws IOException
```
    Throws:
    
    IOException
  - passesTimerangeFilter
```
boolean passesTimerangeFilter(TimeRange timeRange,
                            long oldestUnexpiredTS)
```
    Check if this storeFile may contain keys within the TimeRange that have not expired (i.e. not older than oldestUnexpiredTS).
    
    Parameters:
    timeRange - the timeRange to restrict
    oldestUnexpiredTS - the oldest timestamp that is not expired, as determined by the column family's TTL
    
    Returns:
    false if queried keys definitely don't exist in this StoreFile
  - passesBloomFilter
```
boolean passesBloomFilter(Scan scan,
                        SortedSet<byte[]> columns)
```
    Checks whether the given scan passes the Bloom filter (if present). Only checks Bloom filters for single-row or single-row-column scans. Bloom filter checking for multi-gets is implemented as part of the store scanner system (see StoreFileScanner#seekExactly) and uses the lower-level API passesGeneralBloomFilter(byte[], int, int, byte[], int, int).
    
    Parameters:
    scan - the scan specification. Used to determine the row, and to check whether this is a single-row ("get") scan.
    columns - the set of columns. Only used for row-column Bloom filters.
    
    Returns:
    true if the scan with the given column set passes the Bloom filter, or if the Bloom filter is not applicable for the scan. False if the Bloom filter is applicable and the scan fails it.
  - passesDeleteFamilyBloomFilter
```
public boolean passesDeleteFamilyBloomFilter(byte[] row,
                                    int rowOffset,
                                    int rowLen)
```
  - passesGeneralBloomFilter
```
public boolean passesGeneralBloomFilter(byte[] row,
                               int rowOffset,
                               int rowLen,
                               byte[] col,
                               int colOffset,
                               int colLen)
```
    A method for checking Bloom filters. Called directly from StoreFileScanner in case of a multi-column query.
    
    Parameters:
    row -
    rowOffset -
    rowLen -
    col -
    colOffset -
    colLen -
    
    Returns:
    True if passes
  - passesKeyRangeFilter
```
public boolean passesKeyRangeFilter(Scan scan)
```
    Checks whether the given scan rowkey range overlaps with the current storefile's
    
    Parameters:
    scan - the scan specification. Used to determine the rowkey range.
    
    Returns:
    true if there is overlap, false otherwise
  - loadFileInfo
```
public Map<byte[],byte[]> loadFileInfo()
                                throws IOException
```
    Throws:
    
    IOException
  - loadBloomfilter
```
public void loadBloomfilter()
```
  - loadBloomfilter
```
private void loadBloomfilter(BlockType blockType)
```
  - setBloomFilterFaulty
```
private void setBloomFilterFaulty(BlockType blockType)
```
  - getFilterEntries
```
public long getFilterEntries()
```
    The number of Bloom filter entries in this store file, or an estimate thereof, if the Bloom filter is not loaded. This always returns an upper bound of the number of Bloom filter entries.
    
    Returns:
    an estimate of the number of Bloom filter entries in this file
  - setGeneralBloomFilterFaulty
```
public void setGeneralBloomFilterFaulty()
```
  - setDeleteFamilyBloomFilterFaulty
```
public void setDeleteFamilyBloomFilterFaulty()
```
  - getLastKey
```
public byte[] getLastKey()
```
  - getLastRowKey
```
public byte[] getLastRowKey()
```
  - midkey
```
public byte[] midkey()
              throws IOException
```
    Throws:
    
    IOException
  - length
```
public long length()
```
  - getTotalUncompressedBytes
```
public long getTotalUncompressedBytes()
```
  - getEntries
```
public long getEntries()
```
  - getDeleteFamilyCnt
```
public long getDeleteFamilyCnt()
```
  - getFirstKey
```
public byte[] getFirstKey()
```
  - indexSize
```
public long indexSize()
```
  - getBloomFilterType
```
public BloomType getBloomFilterType()
```
  - getSequenceID
```
public long getSequenceID()
```
  - setSequenceID
```
public void setSequenceID(long sequenceID)
```
  - setBulkLoaded
```
public void setBulkLoaded(boolean bulkLoadResult)
```
  - isBulkLoaded
```
public boolean isBulkLoaded()
```
  - getGeneralBloomFilter
```
BloomFilter getGeneralBloomFilter()
```
  - getUncompressedDataIndexSize
```
long getUncompressedDataIndexSize()
```
  - getTotalBloomSize
```
public long getTotalBloomSize()
```
  - getHFileVersion
```
public int getHFileVersion()
```
  - getHFileMinorVersion
```
public int getHFileMinorVersion()
```
  - getHFileReader
```
public HFile.Reader getHFileReader()
```
  - disableBloomFilterForTesting
```
void disableBloomFilterForTesting()
```
  - getMaxTimestamp
```
public long getMaxTimestamp()
```

Class StoreFile.Reader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

generalBloomFilter

deleteFamilyBloomFilter

bloomFilterType

reader

timeRangeTracker

sequenceID

lastBloomKey

deleteFamilyCnt

bulkLoadResult

Constructor Detail

StoreFile.Reader

StoreFile.Reader

StoreFile.Reader

Method Detail

setReplicaStoreFile

isPrimaryReplicaReader

getComparator

getStoreFileScanner

getStoreFileScanner

getScanner

getScanner

close

passesTimerangeFilter

passesBloomFilter

passesDeleteFamilyBloomFilter

passesGeneralBloomFilter

passesKeyRangeFilter

loadFileInfo

loadBloomfilter

loadBloomfilter

setBloomFilterFaulty

getFilterEntries

setGeneralBloomFilterFaulty

setDeleteFamilyBloomFilterFaulty

getLastKey

getLastRowKey

midkey

length

getTotalUncompressedBytes

getEntries

getDeleteFamilyCnt

getFirstKey

indexSize

getBloomFilterType

getSequenceID

setSequenceID

setBulkLoaded

isBulkLoaded

getGeneralBloomFilter

getUncompressedDataIndexSize

getTotalBloomSize

getHFileVersion

getHFileMinorVersion

getHFileReader

disableBloomFilterForTesting

getMaxTimestamp