hep.aida

Interface IFilter

All Known Implementing Classes:

Filter, RangeSetFilter

public interface IFilter

User's level interface of an IFilter.

Method Summary

Modifier and Type	Method and Description
boolean	accept() Check if the IFilter accepts or not the data in the current row of the ITuple it is associated to.
java.lang.String	expression() Get the expression that defined the IFilter.
void	initialize(ITuple ituple) Initialize the IFilter and associate it to an ITuple.

Method Detail

initialize

void initialize(ITuple ituple)
         throws java.lang.IllegalArgumentException

Initialize the IFilter and associate it to an ITuple.

Parameters:

ituple - The ITuple to which the IFilter is sssociated.

Throws:

java.lang.IllegalArgumentException - If the IFilter and the ITuple are not compatible.

accept

boolean accept()
        throws java.lang.RuntimeException

Check if the IFilter accepts or not the data in the current row of the ITuple it is associated to.

Returns:

true if the current data is accepted.

Throws:

java.lang.RuntimeException - if the IFilter has not been initialized.

expression

java.lang.String expression()

Get the expression that defined the IFilter.

Returns:

The expression.