org.calrissian.accumulorecipes.commons.iterators

Class OrIterator

java.lang.Object

org.calrissian.accumulorecipes.commons.iterators.OrIterator

All Implemented Interfaces:

org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

public class OrIterator
extends Object
implements org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

An iterator that handles "OR" criteria constructs on the server side. This code has been adapted/merged from Heap and Multi Iterators.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OrIterator.TermSource

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
OrIterator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTerm(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source, org.apache.hadoop.io.Text term, org.apache.accumulo.core.iterators.IteratorEnvironment env)
void	addTerm(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source, org.apache.hadoop.io.Text dataLocation, org.apache.hadoop.io.Text term, org.apache.accumulo.core.iterators.IteratorEnvironment env)
protected org.apache.accumulo.core.data.Key	buildTopKey(OrIterator.TermSource TS) Construct the topKey given the current TermSource
org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>	deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)
protected org.apache.hadoop.io.Text	getDataLocation(org.apache.accumulo.core.data.Key key) Returns the given key's dataLocation
protected org.apache.hadoop.io.Text	getDocID(org.apache.accumulo.core.data.Key key) Returns the given key's DocID
protected org.apache.hadoop.io.Text	getPartition(org.apache.accumulo.core.data.Key key) Returns the given key's row
protected org.apache.hadoop.io.Text	getTerm(org.apache.accumulo.core.data.Key key) Returns the given key's term
org.apache.accumulo.core.data.Key	getTopKey()
org.apache.accumulo.core.data.Value	getTopValue()
protected static String	getUID(org.apache.accumulo.core.data.Key key) Returns the given key's UID
boolean	hasTop()
void	init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source, Map<String,String> options, org.apache.accumulo.core.iterators.IteratorEnvironment env)
boolean	jump(org.apache.accumulo.core.data.Key jumpKey)
void	next()
void	seek(org.apache.accumulo.core.data.Range range, Collection<org.apache.accumulo.core.data.ByteSequence> columnFamilies, boolean inclusive)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.log4j.Logger log

Constructor Detail

OrIterator

public OrIterator()

Method Detail

getUID

protected static String getUID(org.apache.accumulo.core.data.Key key)

Returns the given key's UID

Parameters:

key -

Returns:

The given key's UID

getPartition

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

Returns the given key's row

Parameters:

key -

Returns:

The given key's row

getDataLocation

protected org.apache.hadoop.io.Text getDataLocation(org.apache.accumulo.core.data.Key key)

Returns the given key's dataLocation

Parameters:

key -

Returns:

The given key's dataLocation

getTerm

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

Returns the given key's term

Parameters:

key -

Returns:

The given key's term

getDocID

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

Returns the given key's DocID

Parameters:

key -

Returns:

The given key's DocID

deepCopy

public org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)

Specified by:

deepCopy in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

addTerm

public void addTerm(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source,
           org.apache.hadoop.io.Text term,
           org.apache.accumulo.core.iterators.IteratorEnvironment env)

addTerm

public void addTerm(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source,
           org.apache.hadoop.io.Text dataLocation,
           org.apache.hadoop.io.Text term,
           org.apache.accumulo.core.iterators.IteratorEnvironment env)

buildTopKey

protected org.apache.accumulo.core.data.Key buildTopKey(OrIterator.TermSource TS)

Construct the topKey given the current TermSource

Parameters:

TS -

Returns:

The top Key for a given TermSource

next

public final void next()
                throws IOException

Specified by:

next in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

seek

public void seek(org.apache.accumulo.core.data.Range range,
        Collection<org.apache.accumulo.core.data.ByteSequence> columnFamilies,
        boolean inclusive)
          throws IOException

Specified by:

seek in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

getTopKey

public final org.apache.accumulo.core.data.Key getTopKey()

Specified by:

getTopKey in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

getTopValue

public final org.apache.accumulo.core.data.Value getTopValue()

Specified by:

getTopValue in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

hasTop

public final boolean hasTop()

Specified by:

hasTop in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

init

public void init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source,
        Map<String,String> options,
        org.apache.accumulo.core.iterators.IteratorEnvironment env)
          throws IOException

Specified by:

init in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

jump

public boolean jump(org.apache.accumulo.core.data.Key jumpKey)
             throws IOException

Throws:

IOException