com.bigdata.bop.ap.filter
Class BOpFilter

java.lang.Object
  com.bigdata.bop.CoreBaseBOp
      com.bigdata.bop.BOpBase
          com.bigdata.bop.ap.filter.BOpFilterBase
              com.bigdata.bop.ap.filter.BOpFilter

All Implemented Interfaces:

BOp, IFilter, IPropertySet, Serializable, Cloneable

public abstract class BOpFilter
extends BOpFilterBase

Used to filter for objects which satisfy some criteria.

WARNING : DO NOT USE THIS CLASS ON ITupleIterators - use BOpTupleFilter instead.

Version:

$Id: BOpFilter.java 3678 2010-09-29 15:48:34Z thompsonbry $

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

BOpFilter(BOp[] args, Map<String,Object> annotations)
Shallow copy.

BOpFilter(BOpFilter op)
Deep copy.

Method Summary

protected Iterator	filterOnce(Iterator src, Object context) Wrap the source iterator with this filter.
protected abstract boolean	isValid(Object 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

_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, checkArgs, clone, equals, getEvaluationContext, getId, getProperty, getRequiredProperty, hashCode, indent, isController, toShortString, 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

BOpFilter

public BOpFilter(BOpFilter op)

Deep copy.

Parameters:

op -

BOpFilter

public BOpFilter(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(Object obj)

Return true iff the object should be accepted.

Parameters:

obj - The object.