com.bigdata.bop.ap.filter

Class BOpTupleFilter<E>

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.BOpBase

com.bigdata.bop.ap.filter.BOpFilterBase

com.bigdata.bop.ap.filter.BOpTupleFilter<E>

All Implemented Interfaces:

BOp, IFilter, IPropertySet, Serializable, Cloneable

public abstract class BOpTupleFilter<E>
extends BOpFilterBase

Filter supporting ITupleIterators.

Warning: Unlike BOpFilter, this class correctly uses a second Tuple instance to perform filtering. This is necessary since the Tuple instance for the base ITupleIterator implementations for the AbstractBTree is reused by next() on each call and the TupleFilter uses one-step lookahead. Failure to use a second Tuple instance will result in overwrite of the current Tuple with data from the lookahead Tuple.

Note: You must specify IRangeQuery.KEYS and/or IRangeQuery.VALS in order to filter on the keys and/or values associated with the visited tuples.

Note: YOu must specify IRangeQuery.CURSOR to enabled Iterator.remove() for a local BTree

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.bigdata.bop.ap.filter.BOpFilterBase

BOpFilterBase.Annotations

Field Summary

Fields inherited from class com.bigdata.bop.CoreBaseBOp

DEFAULT_INITIAL_CAPACITY

Fields inherited from interface com.bigdata.bop.BOp

NOANNS, NOARGS

Constructor Summary

Constructors

Constructor and Description
BOpTupleFilter(BOp[] args, Map<String,Object> annotations) Shallow copy.
BOpTupleFilter(BOpTupleFilter op) Deep copy.

Method Summary

Methods

Modifier and Type	Method and Description
protected Iterator	filterOnce(Iterator src, Object context) Wrap the source iterator with this filter.
protected abstract boolean	isValid(ITuple<E> obj) Return true iff the object should be accepted.

Methods inherited from class com.bigdata.bop.ap.filter.BOpFilterBase

filter

Methods inherited from class com.bigdata.bop.BOpBase

__replaceArg, _clearProperty, _set, _setProperty, annotations, annotationsCopy, annotationsEqual, annotationsRef, argIterator, args, argsCopy, arity, clearAnnotations, clearProperty, deepCopy, deepCopy, get, getProperty, setArg, setProperty, setUnboundProperty, toArray, toArray

Methods inherited from class com.bigdata.bop.CoreBaseBOp

annotationsEqual, annotationsToString, annotationsToString, annotationValueToString, checkArgs, clone, equals, getEvaluationContext, getId, getProperty, getRequiredProperty, hashCode, indent, isController, mutation, shortenName, toShortString, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

BOpTupleFilter

public BOpTupleFilter(BOpTupleFilter op)

Deep copy.

Parameters:

op -

BOpTupleFilter

public BOpTupleFilter(BOp[] args,
              Map<String,Object> annotations)

Shallow copy.

Parameters:

args -

annotations -

Method Detail

filterOnce

protected final Iterator filterOnce(Iterator src,
                  Object context)

Description copied from class: BOpFilterBase

Wrap the source iterator with this filter.

Specified by:

filterOnce in class BOpFilterBase

Parameters:

src - The source iterator.

context - The iterator evaluation context.

Returns:

The wrapped iterator.

isValid

protected abstract boolean isValid(ITuple<E> obj)

Return true iff the object should be accepted.

Parameters:

obj - The object.