org.richfaces.model
Interface DataProvider<T>

All Superinterfaces:

java.io.Serializable

public interface DataProvider<T>
extends java.io.Serializable

DataProvider is an interface that defines methods for manage loading data.
Usage:

 DataProvider<SomeDataType> dataProvider = new DataProvider<SomeDataType>();
 

Author:

pawelgo

Method Summary

T	getItemByKey(java.lang.Object key) Load single element by given key.
java.util.List<T>	getItemsByRange(int firstRow, int endRow) Loads elements from given range.
java.lang.Object	getKey(T item) Get element key.
int	getRowCount() Get number of all rows.

Method Detail

getRowCount

int getRowCount()

Get number of all rows.

Returns:

number of rows.

getItemsByRange

java.util.List<T> getItemsByRange(int firstRow,
                                  int endRow)

Loads elements from given range. Starting from startRow, and up to but excluding endRow.

Parameters:

firstRow - first row to load

endRow - end row to load

Returns:

element list

getItemByKey

T getItemByKey(java.lang.Object key)

Load single element by given key.

Parameters:

key - element key to be loaded.

Returns:

element or null, if not found

getKey

java.lang.Object getKey(T item)

Get element key. If key is not instance of Integer or org.richfaces.model.ScrollableTableDataModel.SimpleRowKey, it is necessary to implement javax.faces.convert.Converter for key type.

Parameters:

item - element, which key to be get

Returns:

element key