cutthecrap.utils.striterators

Interface IFilter

All Superinterfaces:

IPropertySet, Serializable

All Known Subinterfaces:

ITupleFilter<E>

All Known Implementing Classes:

Advancer, Appender, AtomicRowFilter, BackchainTypeResourceIterator.PushbackFilter, BOpFilter, BOpFilterBase, BOpFilterNOP, BOpResolver, BOpTupleFilter, CacheValueFilter, ContextAdvancer, Contractor, DistinctFilter, DistinctFilter.DistinctFilterImpl, DistinctMultiTermAdvancer, DistinctTermAdvancer, EdgeOnlyFilter, ElementFilter, ExclusionFilter, Expander, FileVersionDeleter, Filter, FilterBase, GeoSpatialServiceFactory.AcceptAllSolutionsFilter, GeoSpatialServiceFactory.GeoSpatialFilterBase, GeoSpatialServiceFactory.GeoSpatialInCircleFilter, LookaheadTupleFilter, Mapper, Merger, NativeDistinctFilter, NativeDistinctFilter.DistinctFilterImpl, NOPFilter, PrefixFilter, Resolver, SameVariableConstraintTupleFilter, SolutionSetStatsFilter, Sorter, StripContextFilter, TupleFilter, TupleObjectResolver, TupleRemover, TupleTransformer, TupleUpdater, UniquenessFilter, Visitor, ZOrderIndexBigMinAdvancer

public interface IFilter
extends Serializable, IPropertySet

Provides the hook interface that allows use by Striterators TODO The Striterator protocol does not support a close() method for Filters. That method should be invoked by an ICloseableIterator.

See Also:

IStriterator does not support close() protocol for Ifilter

Method Summary

Methods

Modifier and Type	Method and Description
Iterator	filter(Iterator src, Object context) The filter method is provided to allow the creation of the filtering iterator.

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Method Detail

filter

Iterator filter(Iterator src,
              Object context)

The filter method is provided to allow the creation of the filtering iterator.

Any implementation should follow the following pattern:

  public Iterator filter(Iterator src, Object context) {
                return new Filterator(src, context, this);
        }
  

This pattern makes the source iterator, the evaluation context, and the IPropertySet annotations visible to the runtime striterator implementation.