org.apache.accumulo.core.iterators
Class IntersectingIterator

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

All Implemented Interfaces:

SortedKeyValueIterator<Key,Value>

Direct Known Subclasses:

FamilyIntersectingIterator

public class IntersectingIterator
extends java.lang.Object
implements SortedKeyValueIterator<Key,Value>

Nested Class Summary

protected static class

IntersectingIterator.TermSource

Field Summary

static java.lang.String	columnFamiliesOptionName
protected boolean	inclusive
protected static org.apache.log4j.Logger	log
static java.lang.String	notFlagOptionName
protected org.apache.hadoop.io.Text	nullText
protected java.util.Collection<ByteSequence>	seekColumnFamilies

Constructor Summary

IntersectingIterator()

IntersectingIterator(IntersectingIterator other, IteratorEnvironment env)

Method Summary

void	addSource(SortedKeyValueIterator<Key,Value> source, IteratorEnvironment env, org.apache.hadoop.io.Text term, boolean notFlag)
protected void	advanceToIntersection()
protected Key	buildFollowingPartitionKey(Key key)
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)
static boolean[]	decodeBooleans(java.lang.String flags)
static org.apache.hadoop.io.Text[]	decodeColumns(java.lang.String columns)
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
static java.lang.String	encodeBooleans(boolean[] flags)
static java.lang.String	encodeColumns(org.apache.hadoop.io.Text[] columns)
protected org.apache.hadoop.io.Text	getDocID(Key key)
protected org.apache.hadoop.io.Text	getPartition(Key key)
protected org.apache.hadoop.io.Text	getTerm(Key key)
Key	getTopKey() Returns top key.
Value	getTopValue() Returns top value.
boolean	hasTop() Returns true if the iterator has more elements.
void	init(SortedKeyValueIterator<Key,Value> source, java.util.Map<java.lang.String,java.lang.String> options, IteratorEnvironment env) Initializes the iterator.
void	next() Advances to the next K,V pair.
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.
static java.lang.String	stringTopKey(SortedKeyValueIterator<Key,Value> iter)

Methods inherited from class java.lang.Object

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

Field Detail

nullText

protected org.apache.hadoop.io.Text nullText

log

protected static final org.apache.log4j.Logger log

seekColumnFamilies

protected java.util.Collection<ByteSequence> seekColumnFamilies

inclusive

protected boolean inclusive

columnFamiliesOptionName

public static final java.lang.String columnFamiliesOptionName

See Also:

Constant Field Values

notFlagOptionName

public static final java.lang.String notFlagOptionName

See Also:

Constant Field Values

Constructor Detail

IntersectingIterator

public IntersectingIterator()

IntersectingIterator

public IntersectingIterator(IntersectingIterator other,
                            IteratorEnvironment env)

Method Detail

getPartition

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

getTerm

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

getDocID

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

buildKey

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

buildKey

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

buildFollowingPartitionKey

protected Key buildFollowingPartitionKey(Key key)

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>

Parameters:

env - IteratorEnvironment environment in which iterator is being run.

Returns:

SortedKeyValueIterator a copy of this iterator (with the same source and settings).

getTopKey

public Key getTopKey()

Description copied from interface: SortedKeyValueIterator

Returns top key. Can be called 0 or more times without affecting behavior of next() or hasTop().

Specified by:

getTopKey in interface SortedKeyValueIterator<Key,Value>

Returns:

K

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>

Returns:

V

hasTop

public boolean hasTop()

Description copied from interface: SortedKeyValueIterator

Returns true if the iterator has more elements.

Specified by:

hasTop in interface SortedKeyValueIterator<Key,Value>

Returns:

true if the iterator has more elements.

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>

Throws:

java.io.IOException - if an I/O error occurs.

advanceToIntersection

protected void advanceToIntersection()
                              throws java.io.IOException

Throws:

java.io.IOException

stringTopKey

public static java.lang.String stringTopKey(SortedKeyValueIterator<Key,Value> iter)

encodeColumns

public static java.lang.String encodeColumns(org.apache.hadoop.io.Text[] columns)

encodeBooleans

public static java.lang.String encodeBooleans(boolean[] flags)

decodeColumns

public static org.apache.hadoop.io.Text[] decodeColumns(java.lang.String columns)

decodeBooleans

public static boolean[] decodeBooleans(java.lang.String flags)

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>

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.

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>

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.

addSource

public void addSource(SortedKeyValueIterator<Key,Value> source,
                      IteratorEnvironment env,
                      org.apache.hadoop.io.Text term,
                      boolean notFlag)