Package org.apache.accumulo.core.file.rfile

Class RFile.Reader

java.lang.Object

org.apache.accumulo.core.iterators.system.HeapIterator

org.apache.accumulo.core.file.rfile.RFile.Reader

All Implemented Interfaces:

AutoCloseable, FileSKVIterator, SortedKeyValueIterator<Key,Value>, InterruptibleIterator

Enclosing class:

RFile

public static class RFile.Reader
extends HeapIterator
implements FileSKVIterator

Constructor Summary

Constructors

Constructor	Description
Reader(BlockFileReader rdr)

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeDeepCopies()
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env)	Creates a deep copy of this iterator as though seek had not yet been called.
Key	getFirstKey()
FileSKVIterator	getIndex()
Key	getLastKey()
Map<String,ArrayList<ByteSequence>>	getLocalityGroupCF()
DataInputStream	getMetaStore(String name)
FileSKVIterator	getSample(SamplerConfigurationImpl sampleConfig)
void	init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env)	Initializes the iterator.
void	printInfo()
void	printInfo(boolean includeIndexDetails)
void	registerMetrics(MetricsGatherer<?> vmg)	Method that registers the given MetricsGatherer.
void	seek(Range range, Collection<ByteSequence> columnFamilies, boolean inclusive)	Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns.
void	setInterruptFlag(AtomicBoolean flag)

Methods inherited from class org.apache.accumulo.core.iterators.system.HeapIterator

addSource, clear, createHeap, getTopKey, getTopValue, hasTop, next

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.accumulo.core.iterators.SortedKeyValueIterator

getTopKey, getTopValue, hasTop, next

Constructor Detail

Reader

public Reader(BlockFileReader rdr)
       throws IOException

Throws:

IOException

Method Detail

closeDeepCopies

public void closeDeepCopies()

Specified by:

closeDeepCopies in interface FileSKVIterator

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FileSKVIterator

Throws:

IOException

getFirstKey

public Key getFirstKey()
                throws IOException

Specified by:

getFirstKey in interface FileSKVIterator

Throws:

IOException

getLastKey

public Key getLastKey()
               throws IOException

Specified by:

getLastKey in interface FileSKVIterator

Throws:

IOException

getMetaStore

public DataInputStream getMetaStore(String name)
                             throws IOException,
                                    NoSuchMetaStoreException

Specified by:

getMetaStore in interface FileSKVIterator

Throws:

IOException

NoSuchMetaStoreException

deepCopy

public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)

Description copied from interface: SortedKeyValueIterator

Creates a deep copy of this iterator as though seek had not yet been called. init should be called on an iterator before deepCopy is called. init should not need to be called on the copy that is returned by deepCopy; that is, when necessary init should be called in the deepCopy method on the iterator it returns. The behavior is unspecified if init is called after deepCopy either on the original or the copy. A proper implementation would call deepCopy on the source.

Specified by:

deepCopy in interface SortedKeyValueIterator<Key,Value>

Parameters:

env - IteratorEnvironment environment in which iterator is being run, provided by Accumulo itself and is expected to be non-null.

Returns:

SortedKeyValueIterator a copy of this iterator (with the same source and settings).

init

public void init(SortedKeyValueIterator<Key,Value> source,
                 Map<String,String> options,
                 IteratorEnvironment env)
          throws IOException

Description copied from interface: SortedKeyValueIterator

Initializes the iterator. Data should not be read from the source in this method.

Specified by:

init in interface SortedKeyValueIterator<Key,Value>

Parameters:

source - SortedKeyValueIterator source to read data from.

options - Map map of string option names to option values.

env - IteratorEnvironment environment in which iterator is being run, provided by Accumulo itself and is expected to be non-null.

Throws:

IOException - unused.

getLocalityGroupCF

public Map<String,ArrayList<ByteSequence>> getLocalityGroupCF()

Returns:

map of locality group names to column families. The default locality group will have null for a name. RFile will only track up to 1000 families for the default locality group. After this it will stop tracking. For the case where the default group has more thn 1000 families an empty list of families is returned.

See Also:

LocalityGroupUtil.seek(FileSKVIterator, Range, String, Map)

registerMetrics

public void registerMetrics(MetricsGatherer<?> vmg)

Method that registers the given MetricsGatherer. You can only register one as it will clobber any previously set. The MetricsGatherer should be registered before iterating through the LocalityGroups.

Parameters:

vmg - MetricsGatherer to be registered with the LocalityGroupReaders

seek

public void seek(Range range,
                 Collection<ByteSequence> columnFamilies,
                 boolean inclusive)
          throws IOException

Description copied from interface: SortedKeyValueIterator

Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns. An iterator does not have to stop at the end of the range. The whole range is provided so that iterators can make optimizations. Seek may be called multiple times with different parameters after SortedKeyValueIterator.init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<K, V>, java.util.Map<java.lang.String, java.lang.String>, org.apache.accumulo.core.iterators.IteratorEnvironment) is called. Iterators that examine groups of adjacent key/value pairs (e.g. rows) to determine their top key and value should be sure that they properly handle a seek to a key in the middle of such a group (e.g. the middle of a row). Even if the client always seeks to a range containing an entire group (a,c), the tablet server could send back a batch of entries corresponding to (a,b], then reseek the iterator to range (b,c) when the scan is continued. columnFamilies is used, at the lowest level, to determine which data blocks inside of an RFile need to be opened for this iterator. This set of data blocks is also the set of locality groups defined for the given table. If no columnFamilies are provided, the data blocks for all locality groups inside of the correct RFile will be opened and seeked in an attempt to find the correct start key, regardless of the startKey in the range. In an Accumulo instance in which multiple locality groups exist for a table, it is important to ensure that columnFamilies is properly set to the minimum required column families to ensure that data from separate locality groups is not inadvertently read.

Specified by:

seek in interface SortedKeyValueIterator<Key,Value>

Parameters:

range - Range of keys to iterate over.

columnFamilies - Collection of column families to include or exclude.

inclusive - boolean that indicates whether to include (true) or exclude (false) column families.

Throws:

IOException - if an I/O error occurs.

getIndex

public FileSKVIterator getIndex()
                         throws IOException

Throws:

IOException

getSample

public FileSKVIterator getSample(SamplerConfigurationImpl sampleConfig)

Specified by:

getSample in interface FileSKVIterator

printInfo

public void printInfo()
               throws IOException

Throws:

IOException

printInfo

public void printInfo(boolean includeIndexDetails)
               throws IOException

Throws:

IOException

setInterruptFlag

public void setInterruptFlag(AtomicBoolean flag)

Specified by:

setInterruptFlag in interface InterruptibleIterator