org.apache.accumulo.core.iterators
Class SkippingIterator

java.lang.Object
  extended by org.apache.accumulo.core.iterators.WrappingIterator
      extended by org.apache.accumulo.core.iterators.SkippingIterator
All Implemented Interfaces:
SortedKeyValueIterator<Key,Value>
Direct Known Subclasses:
ColumnFamilySkippingIterator, FirstEntryInRowIterator, GrepIterator, NoLabelIterator, RegExIterator

public abstract class SkippingIterator
extends WrappingIterator


Constructor Summary
SkippingIterator()
           
 
Method Summary
protected abstract  void consume()
           
 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.
 
Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator
deepCopy, getSource, getTopKey, getTopValue, hasTop, init, setSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SkippingIterator

public SkippingIterator()
Method Detail

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>
Overrides:
next in class WrappingIterator
Throws:
java.io.IOException - if an I/O error occurs.

consume

protected abstract void consume()
                         throws java.io.IOException
Throws:
java.io.IOException

seek

public void seek(Range range,
                 java.util.Collection<ByteSequence> columnFamilies,
                 boolean inclusive)
          throws java.io.IOException
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>
Overrides:
seek in class WrappingIterator
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:
java.io.IOException - if an I/O error occurs.


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