org.cruxframework.crux.core.client.dataprovider

Interface FilterableProvider<T>

All Superinterfaces:

DataProvider<T>

All Known Implementing Classes:

EagerDataProvider, EagerPagedDataProvider

public interface FilterableProvider<T>
extends DataProvider<T>

Classes that implement this interface allow filters on the entire DataProvider set of data.

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilterableProvider.FilterRegistration<T> A registration handler for this filter.

Nested classes/interfaces inherited from interface org.cruxframework.crux.core.client.dataprovider.DataProvider

DataProvider.DataHandler<T>, DataProvider.DataReader<T>

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addDataFilterHandler(DataFilterHandler<T> handler) Add an handler to be called when filter operations are applied
FilterableProvider.FilterRegistration<T>	addFilter(DataFilter<T> filter) Add a new DataFilter to this DataProvider.
void	removeFilters() Remove all filters form the DataProvider

Methods inherited from interface org.cruxframework.crux.core.client.dataprovider.DataProvider

add, add, addDataChangedHandler, addDataLoadedHandler, addDataSortedHandler, addLoadStoppedHandler, addResetHandler, addTransactionEndHandler, addTransactionStartHandler, commit, filter, first, get, get, getNewRecords, getRecord, getRemovedRecords, getSelectedRecords, getUpdatedRecords, hasNext, hasPrevious, indexOf, isDirty, isLoaded, load, next, previous, read, read, remove, reset, rollback, select, select, set, setData, setData, setData, setReadOnly, setReadOnly, sort, stopLoading

Method Detail

addFilter

FilterableProvider.FilterRegistration<T> addFilter(DataFilter<T> filter)

Add a new DataFilter to this DataProvider. All the filters are considered when iterating over the data set.

Parameters:

filter - a filter to verify all DataProvider records

Returns:

a registration handler to enable filter removes.

removeFilters

void removeFilters()

Remove all filters form the DataProvider

addDataFilterHandler

com.google.gwt.event.shared.HandlerRegistration addDataFilterHandler(DataFilterHandler<T> handler)

Add an handler to be called when filter operations are applied

Parameters:

handler - called when filter perform some operation on data