cutthecrap.utils.striterators

Class FilterBase

java.lang.Object

cutthecrap.utils.striterators.FilterBase

All Implemented Interfaces:

IFilter, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

Advancer, Appender, BackchainTypeResourceIterator.PushbackFilter, Contractor, Expander, Filter, LookaheadTupleFilter, Mapper, Merger, NOPFilter, PrefixFilter, Resolver, SolutionSetStatsFilter, Sorter, TupleFilter, TupleRemover, TupleTransformer, Visitor

public abstract class FilterBase
extends Object
implements IFilter, Cloneable

Used with Filterator by Striterator to filter returned objects. This can represent either a single IFilter or a chain of IFilters.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterBase()

Method Summary

Methods

Modifier and Type	Method and Description
FilterBase	addFilter(IFilter filter) Add a filter to the end of this filter chain.
Iterator	filter(Iterator src, Object context) The filter method is provided to allow the creation of the filtering iterator.
protected abstract Iterator	filterOnce(Iterator src, Object context) Wrap the source iterator with this filter.
Object	getProperty(String name) Return the value of a named property.
protected Object	getRequiredProperty(String name) Return the value of a named property.
Object	setProperty(String name, Object value) Set an annotation.
String	toString() Human readable representation of the filter chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterBase

public FilterBase()

Method Detail

addFilter

public final FilterBase addFilter(IFilter filter)

Add a filter to the end of this filter chain.

Parameters:

filter - The filter.

Returns:

This filter.

filter

public final Iterator filter(Iterator src,
              Object context)

Description copied from interface: IFilter

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.

Specified by:

filter in interface IFilter

filterOnce

protected abstract Iterator filterOnce(Iterator src,
                  Object context)

Wrap the source iterator with this filter.

Parameters:

src - The source iterator.

context - The iterator evaluation context.

Returns:

The wrapped iterator.

getProperty

public final Object getProperty(String name)

Description copied from interface: IPropertySet

Return the value of a named property.

Specified by:

getProperty in interface IPropertySet

Parameters:

name - The property name.

Returns:

The property value.

getRequiredProperty

protected final Object getRequiredProperty(String name)

Return the value of a named property.

Parameters:

name - The property name.

Returns:

The property value.

Throws:

IllegalStateException - unless the named property is bound.

setProperty

public final Object setProperty(String name,
                 Object value)

Set an annotation.

Parameters:

name - The name.

value - The value.

Returns:

The old value.

toString

public String toString()

Human readable representation of the filter chain.

Overrides:

toString in class Object