de.alpharogroup.wicket.data.provider

Class AbstractSortableFilterDataProvider<T extends Serializable,S,F extends Serializable>

java.lang.Object

de.alpharogroup.wicket.data.provider.AbstractSortableFilterDataProvider<T,S,F>

Type Parameters:

T - the generic type of the Model for the DataProvider.

S - the generic type for the SortState.

F - the generic type for the Filter.

All Implemented Interfaces:

Serializable, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator<S>, org.apache.wicket.extensions.markup.html.repeater.data.table.filter.IFilterStateLocator<F>, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<T,S>, org.apache.wicket.markup.repeater.data.IDataProvider<T>, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable

public abstract class AbstractSortableFilterDataProvider<T extends Serializable,S,F extends Serializable>
extends Object
implements org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<T,S>, org.apache.wicket.extensions.markup.html.repeater.data.table.filter.IFilterStateLocator<F>

The Class AbstractSortableFilterDataProvider is an abstract generic implementation for the ISortableDataProvider and the IFilterStateLocator interface.

Author:

Asterios Raptis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractSortableFilterDataProvider() Instantiates a new AbstractSortableFilterDataProvider.
AbstractSortableFilterDataProvider(List<T> data) Instantiates a new AbstractSortableFilterDataProvider.

Method Summary

Modifier and Type	Method and Description
void	detach()
protected List<T>	filter(List<T> found) Filter the given list.
org.apache.wicket.extensions.markup.html.repeater.util.SortParam<S>	getSort() Returns current sort state.
Iterator<? extends T>	iterator(long first, long count)
org.apache.wicket.model.IModel<T>	model(T object)
protected org.apache.wicket.extensions.markup.html.repeater.util.SingleSortState<S>	newSortState() Factory method for creating the new SingleSortState for the sort state.
void	setSort(org.apache.wicket.extensions.markup.html.repeater.util.SortParam<S> param) Sets the current sort state.
void	setSort(S property, org.apache.wicket.extensions.markup.html.repeater.data.sort.SortOrder order) Sets the current sort state.
long	size()
protected List<T>	sort() Sorts the given list by getting the SortParam.getProperty() and if not null the given list will be sort.
protected List<T>	sort(List<T> unsortedList) Sorts the given list by getting the SortParam.getProperty() and if not null the given list will be sort.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator

getSortState

Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.table.filter.IFilterStateLocator

getFilterState, setFilterState

Constructor Detail

AbstractSortableFilterDataProvider

public AbstractSortableFilterDataProvider()

Instantiates a new AbstractSortableFilterDataProvider.

AbstractSortableFilterDataProvider

public AbstractSortableFilterDataProvider(List<T> data)

Instantiates a new AbstractSortableFilterDataProvider.

Parameters:

data - the data

Method Detail

newSortState

protected org.apache.wicket.extensions.markup.html.repeater.util.SingleSortState<S> newSortState()

Factory method for creating the new SingleSortState for the sort state. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a new SingleSortState for the sort state.

Returns:

the new SingleSortState for the sort state.

detach

public void detach()

Specified by:

detach in interface org.apache.wicket.model.IDetachable

filter

protected List<T> filter(List<T> found)

Filter the given list. Override this method to implement a filter.

Parameters:

found - the found

Returns:

the list

getSort

public org.apache.wicket.extensions.markup.html.repeater.util.SortParam<S> getSort()

Returns current sort state.

Returns:

current sort state

iterator

public Iterator<? extends T> iterator(long first,
                                      long count)

Specified by:

iterator in interface org.apache.wicket.markup.repeater.data.IDataProvider<T extends Serializable>

model

public org.apache.wicket.model.IModel<T> model(T object)

Specified by:

model in interface org.apache.wicket.markup.repeater.data.IDataProvider<T extends Serializable>

setSort

public void setSort(S property,
                    org.apache.wicket.extensions.markup.html.repeater.data.sort.SortOrder order)

Sets the current sort state.

Parameters:

property - sort property

order - sort order

setSort

public void setSort(org.apache.wicket.extensions.markup.html.repeater.util.SortParam<S> param)

Sets the current sort state.

Parameters:

param - parameter containing new sorting information

size

public long size()

Specified by:

size in interface org.apache.wicket.markup.repeater.data.IDataProvider<T extends Serializable>

sort

protected List<T> sort()

Sorts the given list by getting the SortParam.getProperty() and if not null the given list will be sort.

Returns:

the same list but sorted.

sort

protected List<T> sort(List<T> unsortedList)

Sorts the given list by getting the SortParam.getProperty() and if not null the given list will be sort.

Parameters:

unsortedList - the unsorted list

Returns:

the same list but sorted.