org.apache.accumulo.core.iterators
Class SortedKeyIterator

java.lang.Object
  extended by org.apache.accumulo.core.iterators.WrappingIterator
      extended by org.apache.accumulo.core.iterators.SortedKeyIterator
All Implemented Interfaces:
OptionDescriber, SortedKeyValueIterator<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
SortedKeyIterator()
           
SortedKeyIterator(SortedKeyIterator other, IteratorEnvironment env)
           
 
Method Summary
 SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
          Creates a deep copy of this iterator as though seek had not yet been called.
 OptionDescriber.IteratorOptions describeOptions()
           
 Value getTopValue()
          Returns top value.
 boolean validateOptions(java.util.Map<java.lang.String,java.lang.String> options)
           
 
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
 

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.

Specified by:
deepCopy in interface SortedKeyValueIterator<Key,Value>
Specified by:
deepCopy in class WrappingIterator
Parameters:
env - IteratorEnvironment environment in which iterator is being run.
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().

Specified by:
getTopValue in interface SortedKeyValueIterator<Key,Value>
Overrides:
getTopValue in class WrappingIterator
Returns:
V

describeOptions

public OptionDescriber.IteratorOptions describeOptions()
Specified by:
describeOptions in interface OptionDescriber

validateOptions

public boolean validateOptions(java.util.Map<java.lang.String,java.lang.String> options)
Specified by:
validateOptions in interface OptionDescriber


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.