Class SortedKeyIterator
- java.lang.Object
-
- org.apache.accumulo.core.iterators.WrappingIterator
-
- org.apache.accumulo.core.iterators.SortedKeyIterator
-
- All Implemented Interfaces:
OptionDescriber
,SortedKeyValueIterator<Key,Value>
,YieldingKeyValueIterator<Key,Value>
public class SortedKeyIterator extends WrappingIterator implements OptionDescriber
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber
OptionDescriber.IteratorOptions
-
-
Constructor Summary
Constructors Constructor Description SortedKeyIterator()
SortedKeyIterator(SortedKeyIterator other, IteratorEnvironment env)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SortedKeyValueIterator<Key,Value>
deepCopy(IteratorEnvironment env)
Creates a deep copy of this iterator as though seek had not yet been called.OptionDescriber.IteratorOptions
describeOptions()
Gets an iterator options object that contains information needed to configure this iterator.Value
getTopValue()
Returns top value.boolean
validateOptions(Map<String,String> options)
Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.-
Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator
getSource, getTopKey, hasTop, init, next, seek, setSource
-
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.YieldingKeyValueIterator
enableYielding
-
-
-
-
Constructor Detail
-
SortedKeyIterator
public SortedKeyIterator()
-
SortedKeyIterator
public SortedKeyIterator(SortedKeyIterator other, IteratorEnvironment env)
-
-
Method Detail
-
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 interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
deepCopy
in classWrappingIterator
- 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).
-
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().For performance reasons, iterators reserve the right to reuse objects returned by
getTopValue
whenSortedKeyValueIterator.next()
is called, changing the underlying data that the object references. Iterators that need to save an object returned bygetTopValue
ought to copy the object's data into a new object in order to avoid aliasing bugs.- Specified by:
getTopValue
in interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
getTopValue
in classWrappingIterator
- Returns:
V
-
describeOptions
public OptionDescriber.IteratorOptions describeOptions()
Description copied from interface:OptionDescriber
Gets an iterator options object that contains information needed to configure this iterator. This object will be used by the accumulo shell to prompt the user to input the appropriate information.- Specified by:
describeOptions
in interfaceOptionDescriber
- Returns:
- an iterator options object
-
validateOptions
public boolean validateOptions(Map<String,String> options)
Description copied from interface:OptionDescriber
Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.- Specified by:
validateOptions
in interfaceOptionDescriber
- Parameters:
options
- a map of option names to option values- Returns:
- true if options are valid, false otherwise (IllegalArgumentException preferred)
-
-