org.apache.accumulo.core.iterators
Class ColumnFamilySkippingIterator

java.lang.Object
  org.apache.accumulo.core.iterators.WrappingIterator
      org.apache.accumulo.core.iterators.SkippingIterator
          org.apache.accumulo.core.iterators.ColumnFamilySkippingIterator

All Implemented Interfaces:

InterruptibleIterator, SortedKeyValueIterator<Key,Value>

Direct Known Subclasses:

FileCFSkippingIterator

public class ColumnFamilySkippingIterator
extends SkippingIterator
implements InterruptibleIterator

Field Summary

protected java.util.Set<ByteSequence>	colFamSet
protected boolean	inclusive
protected Range	range
protected java.util.TreeSet<ByteSequence>	sortedColFams

Constructor Summary

	ColumnFamilySkippingIterator(SortedKeyValueIterator<Key,Value> source)
protected	ColumnFamilySkippingIterator(SortedKeyValueIterator<Key,Value> source, java.util.Set<ByteSequence> colFamSet, boolean inclusive)

Method Summary

protected void	consume()
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
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	setInterruptFlag(java.util.concurrent.atomic.AtomicBoolean flag)

Methods inherited from class org.apache.accumulo.core.iterators.SkippingIterator

next

Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator

getSource, getTopKey, getTopValue, hasTop, init, 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.SortedKeyValueIterator

getTopKey, getTopValue, hasTop, init, next

Field Detail

colFamSet

protected java.util.Set<ByteSequence> colFamSet

sortedColFams

protected java.util.TreeSet<ByteSequence> sortedColFams

inclusive

protected boolean inclusive

range

protected Range range

Constructor Detail

ColumnFamilySkippingIterator

public ColumnFamilySkippingIterator(SortedKeyValueIterator<Key,Value> source)

ColumnFamilySkippingIterator

protected ColumnFamilySkippingIterator(SortedKeyValueIterator<Key,Value> source,
                                       java.util.Set<ByteSequence> colFamSet,
                                       boolean inclusive)

Method Detail

consume

protected void consume()
                throws java.io.IOException

Specified by:

consume in class SkippingIterator

Throws:

java.io.IOException

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).

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 SkippingIterator

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.

setInterruptFlag

public void setInterruptFlag(java.util.concurrent.atomic.AtomicBoolean flag)

Specified by:

setInterruptFlag in interface InterruptibleIterator