nl.tudelft.simulation.language.filters
Interface Filterinterface

All Known Implementing Classes:

AbstractFilter

public interface Filterinterface

The FilterInterface is a general interface for all filters in DSOL. Filters can be based on xY combinations, class information ,etc. etc. The API of implementing filters will explain what it expects as input.

(c) copyright 2004 Delft University of Technology , the Netherlands.
See for project information www.simulation.tudelft.nl/dsol
License of use: General Public License (GPL) , no warranty

Since:

1.2

Version:

1.0 Oct 26, 2004

Author:

Niels Lang Peter Jacobs

Method Summary

boolean	accept(java.lang.Object entry) a filter defines whether to accept a value in a chart
Filterinterface	add(Filterinterface filter) adds filter to this filter and returns the composed filter
java.lang.String	getCriterium() returns a string representation of the criterium
boolean	isInverted() is the filter inverted?
Filterinterface	or(Filterinterface filter) creates a new composite filter which is one or two
void	setInverted(boolean inverted) inverts the filter

Method Detail

accept

public boolean accept(java.lang.Object entry)

a filter defines whether to accept a value in a chart

Parameters:

entry - the entry to filter

Returns:

whether to accept this entry

setInverted

public void setInverted(boolean inverted)

inverts the filter

Parameters:

inverted - whether to invert the filter

isInverted

public boolean isInverted()

is the filter inverted?

Returns:

whether the filter is inverted.

getCriterium

public java.lang.String getCriterium()

returns a string representation of the criterium

Returns:

the string representing the criterium

add

public Filterinterface add(Filterinterface filter)

adds filter to this filter and returns the composed filter

Parameters:

filter - the filter to add

Returns:

the composed filter

or

public Filterinterface or(Filterinterface filter)

creates a new composite filter which is one or two

Parameters:

filter - the filter to add

Returns:

the composed filter