org.protempa.backend.dsb.filter

Class PositionFilter

java.lang.Object

org.protempa.backend.dsb.filter.AbstractFilter

org.protempa.backend.dsb.filter.PositionFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

DateTimeFilter

public class PositionFilter
extends AbstractFilter

A filter for a position (e.g., date/time) range.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
PositionFilter(String[] propIds, Long start, Granularity startGran, Long finish, Granularity finishGran) Creates a filter with a position range.
PositionFilter(String[] propIds, Long start, Granularity startGran, Long finish, Granularity finishGran, Interval.Side startSide, Interval.Side finishSide) Initializes a filter with a position range.

Method Summary

Modifier and Type	Method and Description
void	accept(FilterVisitor visitor) Performs some processing on this filter.
boolean	equals(Object obj)
Long	getFinish() Returns the finish position supplied in the constructor.
Granularity	getFinishGranularity() Returns the Granularity with which to interpret the finish position.
Interval.Side	getFinishSide() Returns the side of the proposition to which to apply the upper bound.
Long	getMaximumFinish() Returns the maximum finish position in Protempa's Long representation.
Long	getMaximumStart() Returns the maximum start position in Protempa's Long representation.
Long	getMinimumFinish() Returns the minimum finish position in Protempa's Long representation.
Long	getMinimumStart() Returns the minimum start position in Protempa's Long representation.
Long	getStart() Returns the start position supplied in the constructor.
Granularity	getStartGranularity() Returns the Granularity with which to interpret the start position.
Interval.Side	getStartSide() Returns the side of the proposition to which to apply the lower bound.
int	hashCode()
String	toString()

Methods inherited from class org.protempa.backend.dsb.filter.AbstractFilter

andIterator, chainLength, filterArrayToChain, filterChainToArray, getAnd, getPropositionIds, setAnd

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionFilter

public PositionFilter(String[] propIds,
                      Long start,
                      Granularity startGran,
                      Long finish,
                      Granularity finishGran)

Creates a filter with a position range.

Parameters:

propIds - a String[] of proposition ids on which to filter.

start - the start position in Protempa's Long representation.

startGran - the Granularity with which to interpret the start position.

finish - the finish position in Protempa's Long representation.

finishGran - the Granularity with which to interpret the finish position.

PositionFilter

public PositionFilter(String[] propIds,
                      Long start,
                      Granularity startGran,
                      Long finish,
                      Granularity finishGran,
                      Interval.Side startSide,
                      Interval.Side finishSide)

Initializes a filter with a position range.

Parameters:

propIds - a String[] of proposition ids on which to filter.

start - the start position in Protempa's Long representation.

startGran - the Granularity with which to interpret the start position.

finish - the finish position in Protempa's Long representation.

finishGran - the Granularity with which to interpret the finish position.

startSide - the Interval.Side of the proposition to which to apply the start bound. The default is Side.START (if null is specified). Ignored for timestamped propositions.

finishSide - the Interval.Side of the proposition to which to apply the finish bound. The default is Side.FINISH (if null is specified). Ignored for timestamped propositions.

Method Detail

getStartGranularity

public Granularity getStartGranularity()

Returns the Granularity with which to interpret the start position.

Returns:

the startGranularity a Granularity.

getFinishGranularity

public Granularity getFinishGranularity()

Returns the Granularity with which to interpret the finish position.

Returns:

the finishGranularity a Granularity.

getMaximumFinish

public Long getMaximumFinish()

Returns the maximum finish position in Protempa's Long representation.

Returns:

a Long.

getMaximumStart

public Long getMaximumStart()

Returns the maximum start position in Protempa's Long representation.

Returns:

a Long.

getMinimumFinish

public Long getMinimumFinish()

Returns the minimum finish position in Protempa's Long representation.

Returns:

a Long.

getMinimumStart

public Long getMinimumStart()

Returns the minimum start position in Protempa's Long representation.

Returns:

a Long.

getStart

public Long getStart()

Returns the start position supplied in the constructor.

Returns:

a Long.

getFinish

public Long getFinish()

Returns the finish position supplied in the constructor.

Returns:

a Long.

getStartSide

public Interval.Side getStartSide()

Returns the side of the proposition to which to apply the lower bound.

Returns:

a Interval.Side.

getFinishSide

public Interval.Side getFinishSide()

Returns the side of the proposition to which to apply the upper bound.

Returns:

a Interval.Side.

accept

public void accept(FilterVisitor visitor)

Description copied from interface: Filter

Performs some processing on this filter.

Parameters:

visitor - a FilterVisitor. Cannot be null.

toString

public String toString()

Overrides:

toString in class AbstractFilter

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object