net.sf.jasperreports.engine

Interface DatasetFilter

All Known Implementing Classes:

CompositeDatasetFilter, FieldFilter

public interface DatasetFilter

A dataset row filter.

Such a filter can be used in addition to the dataset filter expression to match dataset rows based on a programmatic criteria.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

JRParameter.FILTER, JRDataset.getFilterExpression()

Method Summary

Modifier and Type	Method and Description
void	init(DatasetFillContext context) Initializes the filter.
boolean	matches(EvaluationType evaluation) Determines whether the current row matches the filter criteria.

Method Detail

init

void init(DatasetFillContext context)

Initializes the filter.

Parameters:

context - dataset context information

matches

boolean matches(EvaluationType evaluation)

Determines whether the current row matches the filter criteria. Matching rows are included in the report, while non-matching rows are skipped.

Parameters:

evaluation - the evaluation type. Currently only EvaluationType.ESTIMATED is used.

Returns:

true if the row is to be included in the report.