org.apache.accumulo.core.iterators
Class FamilyIntersectingIterator

java.lang.Object
  org.apache.accumulo.core.iterators.IntersectingIterator
      org.apache.accumulo.core.iterators.FamilyIntersectingIterator

All Implemented Interfaces:

SortedKeyValueIterator<Key,Value>

public class FamilyIntersectingIterator
extends IntersectingIterator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.accumulo.core.iterators.IntersectingIterator

IntersectingIterator.TermSource

Field Summary

static org.apache.hadoop.io.Text	DEFAULT_DOC_COLF
static org.apache.hadoop.io.Text	DEFAULT_INDEX_COLF
static java.lang.String	docFamilyOptionName
SortedKeyValueIterator<Key,Value>	docSource
static java.lang.String	indexFamilyOptionName

Fields inherited from class org.apache.accumulo.core.iterators.IntersectingIterator

columnFamiliesOptionName, inclusive, log, notFlagOptionName, nullText, seekColumnFamilies

Constructor Summary

FamilyIntersectingIterator()

Method Summary

protected void	advanceToIntersection()
protected Key	buildDocKey()
protected Key	buildKey(org.apache.hadoop.io.Text partition, org.apache.hadoop.io.Text term)
protected Key	buildKey(org.apache.hadoop.io.Text partition, org.apache.hadoop.io.Text term, org.apache.hadoop.io.Text docID)
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
protected org.apache.hadoop.io.Text	getDocID(Key key)
protected org.apache.hadoop.io.Text	getTerm(Key key)
void	init(SortedKeyValueIterator<Key,Value> source, java.util.Map<java.lang.String,java.lang.String> options, IteratorEnvironment env) Initializes the iterator.
void	seek(Range range, java.util.Collection<ByteSequence> seekColumnFamilies, 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.IntersectingIterator

addSource, buildFollowingPartitionKey, decodeBooleans, decodeColumns, encodeBooleans, encodeColumns, getPartition, getTopKey, getTopValue, hasTop, next, stringTopKey

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDEX_COLF

public static final org.apache.hadoop.io.Text DEFAULT_INDEX_COLF

DEFAULT_DOC_COLF

public static final org.apache.hadoop.io.Text DEFAULT_DOC_COLF

indexFamilyOptionName

public static final java.lang.String indexFamilyOptionName

See Also:

Constant Field Values

docFamilyOptionName

public static final java.lang.String docFamilyOptionName

See Also:

Constant Field Values

docSource

public SortedKeyValueIterator<Key,Value> docSource

Constructor Detail

FamilyIntersectingIterator

public FamilyIntersectingIterator()

Method Detail

buildKey

protected Key buildKey(org.apache.hadoop.io.Text partition,
                       org.apache.hadoop.io.Text term,
                       org.apache.hadoop.io.Text docID)

Overrides:

buildKey in class IntersectingIterator

buildKey

protected Key buildKey(org.apache.hadoop.io.Text partition,
                       org.apache.hadoop.io.Text term)

Overrides:

buildKey in class IntersectingIterator

getDocID

protected org.apache.hadoop.io.Text getDocID(Key key)

Overrides:

getDocID in class IntersectingIterator

getTerm

protected org.apache.hadoop.io.Text getTerm(Key key)

Overrides:

getTerm in class IntersectingIterator

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>

Overrides:

init in class IntersectingIterator

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.

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>

Overrides:

deepCopy in class IntersectingIterator

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> seekColumnFamilies,
                 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 IntersectingIterator

Parameters:

range - Range of keys to iterate over.

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

advanceToIntersection

protected void advanceToIntersection()
                              throws java.io.IOException

Overrides:

advanceToIntersection in class IntersectingIterator

Throws:

java.io.IOException

buildDocKey

protected Key buildDocKey()