org.apache.accumulo.core.iterators.user
Class WholeRowIterator

java.lang.Object
  org.apache.accumulo.core.iterators.user.WholeRowIterator

All Implemented Interfaces:

SortedKeyValueIterator<Key,Value>

Direct Known Subclasses:

WholeRowIterator

public class WholeRowIterator
extends Object
implements SortedKeyValueIterator<Key,Value>

The WholeRowIterator is designed to provide row-isolation so that queries see mutations as atomic. It does so by encapsulating an entire row of key/value pairs into a single key/value pair, which is returned through the client as an atomic operation.

One caveat is that when seeking in the WholeRowIterator using a range that starts at a non-inclusive first key in a row, (e.g. seek(new Range(new Key(new Text("row")),false,...),...)) this iterator will skip to the next row. This is done in order to prevent repeated scanning of the same row when system automatically creates ranges of that form, which happens in the case of the client calling continueScan, or in the case of the tablet server continuing a scan after swapping out sources.

To regain the original key/value pairs of the row, call the decodeRow function on the key/value pair that this iterator returned.

See Also:

RowFilter

Constructor Summary

WholeRowIterator()

Method Summary

static SortedMap<Key,Value>	decodeRow(Key rowKey, Value rowValue)
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
static Value	encodeRow(List<Key> keys, List<Value> values)
protected boolean	filter(org.apache.hadoop.io.Text currentRow, List<Key> keys, List<Value> values)
Key	getTopKey() Returns top key.
Value	getTopValue() Returns top value.
boolean	hasTop() Returns true if the iterator has more elements.
void	init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) Initializes the iterator.
void	next() Advances to the next K,V pair.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WholeRowIterator

public WholeRowIterator()

Method Detail

decodeRow

public static final SortedMap<Key,Value> decodeRow(Key rowKey,
                                                   Value rowValue)
                                            throws IOException

Throws:

IOException

encodeRow

public static final Value encodeRow(List<Key> keys,
                                    List<Value> values)
                             throws IOException

Throws:

IOException

filter

protected boolean filter(org.apache.hadoop.io.Text currentRow,
                         List<Key> keys,
                         List<Value> values)

Parameters:

currentRow - All keys have this in their row portion (do not modify!).

keys - One key for each key in the row, ordered as they are given by the source iterator (do not modify!).

values - One value for each key in keys, ordered to correspond to the ordering in keys (do not modify!).

Returns:

true if we want to keep the row, false if we want to skip it

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.

Specified by:

deepCopy in interface SortedKeyValueIterator<Key,Value>

Parameters:

env - IteratorEnvironment environment in which iterator is being run.

Returns:

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

getTopKey

public Key getTopKey()

Description copied from interface: SortedKeyValueIterator

Returns top key. Can be called 0 or more times without affecting behavior of next() or hasTop(). Note that in minor compaction scope and in non-full major compaction scopes the iterator may see deletion entries. These entries should be preserved by all iterators except ones that are strictly scan-time iterators that will never be configured for the minc or majc scopes. Deletion entries are only removed during full major compactions.

Specified by:

getTopKey in interface SortedKeyValueIterator<Key,Value>

Returns:

K

getTopValue

public Value getTopValue()

Description copied from interface: SortedKeyValueIterator

Returns top value. Can be called 0 or more times without affecting behavior of next() or hasTop().

Specified by:

getTopValue in interface SortedKeyValueIterator<Key,Value>

Returns:

V

hasTop

public boolean hasTop()

Description copied from interface: SortedKeyValueIterator

Returns true if the iterator has more elements.

Specified by:

hasTop in interface SortedKeyValueIterator<Key,Value>

Returns:

true if the iterator has more elements.

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.

Throws:

IOException - unused.

next

public void next()
          throws IOException

Description copied from interface: SortedKeyValueIterator

Advances to the next K,V pair. Note that in minor compaction scope and in non-full major compaction scopes the iterator may see deletion entries. These entries should be preserved by all iterators except ones that are strictly scan-time iterators that will never be configured for the minc or majc scopes. Deletion entries are only removed during full major compactions.

Specified by:

next in interface SortedKeyValueIterator<Key,Value>

Throws:

IOException - if an I/O error occurs.

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, java.util.Map, 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, irregardless 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.