com.day.cq.reporting

Interface Filter

public interface Filter

This interface represents a filter used for reports.

Method Summary

Modifier and Type	Method and Description
void	configure(FilterSettings settings) Configures the filter.
FilterSettings	createSettings() Creates a FilterSettings object that is suitable for configuring the filter.
String	getId() Gets the filter's ID.
boolean	isActive() Checks if the filter is active.
boolean	isMatching(CellValue cellData) Checks if the specified data row matches the filter (= should be included in the result set due to current filter settings).

Method Detail

getId

String getId()

Gets the filter's ID.

Returns:

The filter ID

createSettings

FilterSettings createSettings()

Creates a FilterSettings object that is suitable for configuring the filter.

Returns:

The FilterSettings object

configure

void configure(FilterSettings settings)

Configures the filter.

Parameters:

settings - the filter's settings

isActive

boolean isActive()

Checks if the filter is active.

Returns:

true if the filter is active

isMatching

boolean isMatching(CellValue cellData)

Checks if the specified data row matches the filter (= should be included in the result set due to current filter settings).

Note that this method may only be called if this.isActive() == true.

Parameters:

cellData - The data to check

Returns:

True if the data row matches the filter