org.protempa.backend.dsb.filter

Class AbstractFilter

java.lang.Object

org.protempa.backend.dsb.filter.AbstractFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

PositionFilter, PropertyValueFilter, ValueFilter

public abstract class AbstractFilter
extends Object
implements Filter

An abstract class that makes implementing filters relatively easy.

Author:

Andrew Post.

Constructor Summary

Constructors

Constructor and Description
AbstractFilter(String[] propositionIds) Instantiates the filter with the proposition ids that it is valid for.

Method Summary

Modifier and Type	Method and Description
Iterator<Filter>	andIterator() Returns an iterator over this filter and all subsequent filters in the chain.
int	chainLength()
static Filter	filterArrayToChain(Filter[] filterArray) Convert an array of AbstractFilter objects to a chain of filters by calling the setAnd(org.protempa.backend.dsb.filter.Filter) the method of each filter object.
Filter[]	filterChainToArray() Return an array that contains all of the filters in the chain.
Filter	getAnd() Returns the next filter in the chain, if specified.
String[]	getPropositionIds() Returns the proposition ids for which this filter is valid.
void	setAnd(Filter and)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.backend.dsb.filter.Filter

accept

Constructor Detail

AbstractFilter

public AbstractFilter(String[] propositionIds)

Instantiates the filter with the proposition ids that it is valid for.

Parameters:

propositionIds - a proposition id String[]. Cannot be null , empty or contain null values.

Method Detail

getPropositionIds

public String[] getPropositionIds()

Description copied from interface: Filter

Returns the proposition ids for which this filter is valid. Implementors of this class are not required to validate supplied proposition ids to ensure that they are all supplied by a data source directly (i.e., not derived), thus it could potentially return the ids of derived propositions.

Specified by:

getPropositionIds in interface Filter

Returns:

a proposition id String[]. Is guaranteed not to return null, an empty array or an array containing null values.

setAnd

public void setAnd(Filter and)

getAnd

public Filter getAnd()

Description copied from interface: Filter

Returns the next filter in the chain, if specified.

Specified by:

getAnd in interface Filter

Returns:

a Filter, or null if there are no more filters in the chain.

andIterator

public Iterator<Filter> andIterator()

Description copied from interface: Filter

Returns an iterator over this filter and all subsequent filters in the chain.

Specified by:

andIterator in interface Filter

Returns:

an Iterator.

toString

public String toString()

Overrides:

toString in class Object

filterArrayToChain

public static Filter filterArrayToChain(Filter[] filterArray)

Convert an array of AbstractFilter objects to a chain of filters by calling the setAnd(org.protempa.backend.dsb.filter.Filter) the method of each filter object.

Parameters:

filterArray - An array of AbstractFilter objects having length greater than zero.

Returns:

The first filter in the chain which will be == to filterArray[0]

chainLength

public int chainLength()

Returns:

the length of the filter chain that begins with this object.

filterChainToArray

public Filter[] filterChainToArray()

Return an array that contains all of the filters in the chain.

Specified by:

filterChainToArray in interface Filter