org.apache.accumulo.core.iterators
Class ScanCache

java.lang.Object
  org.apache.accumulo.core.iterators.ScanCache

All Implemented Interfaces:

SortedKeyValueIterator<Key,Value>

public class ScanCache
extends java.lang.Object
implements SortedKeyValueIterator<Key,Value>

Constructor Summary

ScanCache(long maxSize, KeyExtent extent)

Method Summary

ScanCache	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
void	finishScan()
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, java.util.Map<java.lang.String,java.lang.String> options, IteratorEnvironment env) Initializes the iterator.
void	invalidate(Key key)
void	next() Advances to the next K,V pair.
void	seek(Range range, java.util.Collection<ByteSequence> columnFamilies, boolean inclusive) An iterator must seek to the first key in the range taking inclusiveness into account.
void	setAuthorityIterator(SortedKeyValueIterator<Key,Value> authorityIter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanCache

public ScanCache(long maxSize,
                 KeyExtent extent)

Method Detail

deepCopy

public ScanCache 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().

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.

next

public void next()
          throws java.io.IOException

Description copied from interface: SortedKeyValueIterator

Advances to the next K,V pair.

Specified by:

next in interface SortedKeyValueIterator<Key,Value>

Throws:

java.io.IOException - if an I/O error occurs.

setAuthorityIterator

public void setAuthorityIterator(SortedKeyValueIterator<Key,Value> authorityIter)

seek

public void seek(Range range,
                 java.util.Collection<ByteSequence> columnFamilies,
                 boolean inclusive)

Description copied from interface: SortedKeyValueIterator

An iterator must seek to the first key in the range taking inclusiveness into account. However, an iterator does not have to stop at the end of the range. The whole range is provided so that iterators can make optimizations.

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.

finishScan

public void finishScan()

invalidate

public void invalidate(Key key)

init

public void init(SortedKeyValueIterator<Key,Value> source,
                 java.util.Map<java.lang.String,java.lang.String> options,
                 IteratorEnvironment env)
          throws java.io.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:

java.io.IOException - unused.