nl.tudelft.simulation.language.filters
Interface Filterinterface

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractFilter, CompositeFilter, MaxPointFilter, ModulusFilter, ZeroFilter

public interface Filterinterface
extends Serializable

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 2002-2005 Delft University of Technology , the Netherlands.

See for project information www.simulation.tudelft.nl/language
License of use: Lesser General Public License (LGPL) , no warranty

Since:
1.2
Version:
$Revision: 1.1 $ $Date: 2007/01/06 13:25:54 $
Author:
Niels Lang Peter Jacobs

Method Summary
 boolean accept(Object entry)
          a filter defines whether to accept a value in a chart
 Filterinterface and(Filterinterface filter)
          adds filter to this filter and returns the composed filter
 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

boolean accept(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

void setInverted(boolean inverted)
inverts the filter

Parameters:
inverted - whether to invert the filter

isInverted

boolean isInverted()
is the filter inverted?

Returns:
whether the filter is inverted.

getCriterium

String getCriterium()
returns a string representation of the criterium

Returns:
the string representing the criterium

and

Filterinterface and(Filterinterface filter)
adds filter to this filter and returns the composed filter

Parameters:
filter - the filter to add
Returns:
the composed filter

or

Filterinterface or(Filterinterface filter)
creates a new composite filter which is one or two

Parameters:
filter - the filter to add
Returns:
the composed filter


Copyright © 2002-2011 Delft University of Technology, the Netherlands. All Rights Reserved.