org.calrissian.accumulorecipes.commons.iterators

Class BooleanLogicIterator

java.lang.Object

org.calrissian.accumulorecipes.commons.iterators.BooleanLogicIterator

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BooleanLogicIterator.BooleanLogicTreeNodeComparator

Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber

org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_INDEX_QUERY
static String	FIELD_NAME_PREFIX
protected static org.apache.log4j.Logger	log
protected org.apache.hadoop.io.Text	nullText
static String	QUERY_OPTION
static String	TERM_CARDINALITIES

Constructor Summary

Constructors

Constructor and Description
BooleanLogicIterator()
BooleanLogicIterator(BooleanLogicIterator other, org.apache.accumulo.core.iterators.IteratorEnvironment env)

Method Summary

Methods

Modifier and Type	Method and Description
static void	collapseBranches(BooleanLogicTreeNode myroot)
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)
org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions	describeOptions()
org.apache.accumulo.core.data.Key	getTopKey()
org.apache.accumulo.core.data.Value	getTopValue()
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) init is responsible for setting up the iterator.
void	next()
BooleanLogicTreeNode	refactorTree(BooleanLogicTreeNode myroot)
void	seek(org.apache.accumulo.core.data.Range range, Collection<org.apache.accumulo.core.data.ByteSequence> columnFamilies, boolean inclusive)
void	setDebug(org.apache.log4j.Level lev)
static void	setLogLevel(org.apache.log4j.Level lev)
static void	showBreadthFirstTraversal(BooleanLogicTreeNode root)
static void	showDepthFirstTraversal(BooleanLogicTreeNode root) Small utility function to print out the depth-first enumeration of the tree.
BooleanLogicTreeNode	transformTreeNode(TreeNode node)
boolean	validateOptions(Map<String,String> options)

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_OPTION

public static final String QUERY_OPTION

See Also:

Constant Field Values

TERM_CARDINALITIES

public static final String TERM_CARDINALITIES

See Also:

Constant Field Values

FIELD_INDEX_QUERY

public static final String FIELD_INDEX_QUERY

See Also:

Constant Field Values

FIELD_NAME_PREFIX

public static final String FIELD_NAME_PREFIX

See Also:

Constant Field Values

log

protected static final org.apache.log4j.Logger log

nullText

protected org.apache.hadoop.io.Text nullText

Constructor Detail

BooleanLogicIterator

public BooleanLogicIterator()

BooleanLogicIterator

public BooleanLogicIterator(BooleanLogicIterator other,
                    org.apache.accumulo.core.iterators.IteratorEnvironment env)

Method Detail

setLogLevel

public static void setLogLevel(org.apache.log4j.Level lev)

collapseBranches

public static void collapseBranches(BooleanLogicTreeNode myroot)
                             throws Exception

Throws:

Exception

showDepthFirstTraversal

public static void showDepthFirstTraversal(BooleanLogicTreeNode root)

Small utility function to print out the depth-first enumeration of the tree. Specify the root or sub root of the tree you wish to view.

Parameters:

root - The root node of the tree or sub-tree.

showBreadthFirstTraversal

public static void showBreadthFirstTraversal(BooleanLogicTreeNode root)

setDebug

public void setDebug(org.apache.log4j.Level lev)

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>

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

init is responsible for setting up the iterator. It will pull the serialized boolean parse tree from the options mapping and construct the appropriate sub-iterators

Once initialized, this iterator will automatically seek to the first matching instance. If no top key exists, that means an event matching the boolean logic did not exist in the partition. Subsequent calls to next will move the iterator and all sub-iterators to the next match.

Specified by:

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

Parameters:

source - The underlying SortedkeyValueIterator.

options - A Map of options.

env - The iterator environment

Throws:

IOException

transformTreeNode

public BooleanLogicTreeNode transformTreeNode(TreeNode node)
                                       throws org.apache.commons.jexl2.parser.ParseException

Throws:

org.apache.commons.jexl2.parser.ParseException

refactorTree

public BooleanLogicTreeNode refactorTree(BooleanLogicTreeNode myroot)

hasTop

public 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>

getTopKey

public 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 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>

next

public 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

describeOptions

public org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions describeOptions()

Specified by:

describeOptions in interface org.apache.accumulo.core.iterators.OptionDescriber

validateOptions

public boolean validateOptions(Map<String,String> options)

Specified by:

validateOptions in interface org.apache.accumulo.core.iterators.OptionDescriber