org.cruxframework.crux.core.client.dataprovider
Interface DataProvider<E>

All Known Subinterfaces:

AsyncDataProvider<E>, MeasurableAsyncDataProvider<E>, MeasurableDataProvider<E>, MeasurablePagedDataProvider<E>, PagedDataProvider<E>, StreamingDataProvider<E>, SyncDataProvider<E>

All Known Implementing Classes:

AsyncPagedDataProvider, AsyncStreamingDataProvider, SyncPagedDataProvider, SyncScrollableDataProvider

public interface DataProvider<E>

A DataProvider is used to provide information to widgets that implements HasDataProvider interface, like Crux Grid.

Author:

Thiago da Rosa de Bustamante

Method Summary

void	clearChanges() Undo all changes
void	firstRecord() Points DataProvider to first record
E	getBoundObject() Return a copy of the current record object.
int	getIndex(E boundObject) Retrieve the index of the given object
DataProviderRecord<E>[]	getNewRecords() Return all records inserted on DataProvider
DataProviderRecord<E>	getRecord() Return the DataProviderRecord object, representing the current record
DataProviderRecord<E>[]	getRemovedRecords() Return all records removed from DataProvider
DataProviderRecord<E>[]	getSelectedRecords() Return all records selected on DataProvider
DataProviderRecord<E>[]	getUpdatedRecords() Return all records modified on DataProvider
boolean	hasNextRecord() Verify if DataProvider has more records.
boolean	hasPreviousRecord() Verify if DataProvider has previous records.
DataProviderRecord<E>	insertRecord(int beforeRecord) Insert a new record on DataProvider
void	nextRecord() Points DataProvider to next record
void	previousRecord() Points DataProvider to previous record
DataProviderRecord<E>	removeRecord(int record) Remove a record from DataProvider
void	reset() Reset DataProvider, as if it was never loaded before.
void	selectRecord(int index, boolean selected) Mark the given record as selected
void	sort(Comparator<E> comparator) Sort DataProvider records, based on column informed
void	updateData(Array<E> data) Method called to bind some data to the DataProvider
void	updateData(E[] data) Method called to bind some data to the DataProvider
void	updateData(List<E> data) Method called to bind some data to the DataProvider
void	updateState(DataProviderRecord<E> record, DataProviderRecord.DataProviderRecordState previousState) Update a record on DataProvider

Method Detail

firstRecord

void firstRecord()

Points DataProvider to first record

hasNextRecord

boolean hasNextRecord()

Verify if DataProvider has more records.

Returns:

true if more records exist.

nextRecord

void nextRecord()

Points DataProvider to next record

hasPreviousRecord

boolean hasPreviousRecord()

Verify if DataProvider has previous records.

Returns:

true if previous records exist.

previousRecord

void previousRecord()

Points DataProvider to previous record

sort

void sort(Comparator<E> comparator)

Sort DataProvider records, based on column informed

Parameters:

comparator - Comparator used for sorting.

reset

void reset()

Reset DataProvider, as if it was never loaded before.

getRecord

DataProviderRecord<E> getRecord()

Return the DataProviderRecord object, representing the current record

Returns:

current DataProviderRecord object.

getBoundObject

E getBoundObject()

Return a copy of the current record object.

Returns:

insertRecord

DataProviderRecord<E> insertRecord(int beforeRecord)

Insert a new record on DataProvider

Parameters:

beforeRecord -

Returns:

removeRecord

DataProviderRecord<E> removeRecord(int record)

Remove a record from DataProvider

Parameters:

record -

Returns:

updateState

void updateState(DataProviderRecord<E> record,
                 DataProviderRecord.DataProviderRecordState previousState)

Update a record on DataProvider

Parameters:

record -

previousState -

getNewRecords

DataProviderRecord<E>[] getNewRecords()

Return all records inserted on DataProvider

Returns:

all new records

getRemovedRecords

DataProviderRecord<E>[] getRemovedRecords()

Return all records removed from DataProvider

Returns:

all removed records

getUpdatedRecords

DataProviderRecord<E>[] getUpdatedRecords()

Return all records modified on DataProvider

Returns:

all modified records

getSelectedRecords

DataProviderRecord<E>[] getSelectedRecords()

Return all records selected on DataProvider

Returns:

all selected records

clearChanges

void clearChanges()

Undo all changes

getIndex

int getIndex(E boundObject)

Retrieve the index of the given object

Parameters:

boundObject -

Returns:

selectRecord

void selectRecord(int index,
                  boolean selected)

Mark the given record as selected

Parameters:

index -

selected -

updateData

void updateData(E[] data)

Method called to bind some data to the DataProvider

Parameters:

data -

updateData

void updateData(List<E> data)

Method called to bind some data to the DataProvider

Parameters:

data -

updateData

void updateData(Array<E> data)

Method called to bind some data to the DataProvider

Parameters:

data -