org.cruxframework.crux.core.client.dataprovider

Class EagerDataProvider<T>

java.lang.Object

org.cruxframework.crux.core.client.dataprovider.AbstractDataProvider<T>

org.cruxframework.crux.core.client.dataprovider.EagerDataProvider<T>

All Implemented Interfaces:

DataProvider<T>, EagerProvider<T>, FilterableProvider<T>, MeasurableProvider<T>

public class EagerDataProvider<T>
extends AbstractDataProvider<T>
implements EagerProvider<T>, FilterableProvider<T>

An Eager and filterable DataProvider

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

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

FilterableProvider.FilterRegistration<T>

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected EagerDataLoader<T>	dataLoader
protected org.cruxframework.crux.core.client.dataprovider.DataProviderOperations<T>	operations

Fields inherited from class org.cruxframework.crux.core.client.dataprovider.AbstractDataProvider

currentRecord, data, dataChangedHandlers, dataHandler, dataLoadedHandlers, dataSortedHandlers, dataStopLoadHandlers, loaded, resetHandlers, transactionEndHandlers, transactionStartHandlers

Constructor Summary

Constructors

Constructor and Description
EagerDataProvider(DataProvider.DataHandler<T> handler)
EagerDataProvider(DataProvider.DataHandler<T> handler, EagerDataLoader<T> dataLoader)

Method Summary

Methods

Modifier and Type	Method and Description
DataProviderRecord<T>	add(int beforeIndex, T object) Insert a new object on DataProvider
DataProviderRecord<T>	add(T object) Insert a new object on DataProvider
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.
protected void	changePositionAfterSorting()
void	commit() Confirm all changes
protected void	ensureLoaded()
Array<T>	filter(DataFilter<T> filter) Return a filtered set of data, applying the given filter to the whole set of data.
void	first() Points DataProvider to first record
Array<T>	getData() Retrieve all data loaded into this DataProvider
EagerDataLoader<T>	getDataLoader() Retrieve the EagerDataLoader used to load data
DataProviderRecord<T>[]	getNewRecords() Return all records inserted on DataProvider
DataProviderRecord<T>	getRecord() Return the DataProviderRecord object, representing the current record
DataProviderRecord<T>[]	getRemovedRecords() Return all records removed from DataProvider
DataProviderRecord<T>[]	getSelectedRecords() Return all records selected on DataProvider
protected Array<DataProviderRecord<T>>	getTransactionRecords()
DataProviderRecord<T>[]	getUpdatedRecords() Return all records modified on DataProvider
boolean	hasNext() Verify if DataProvider has more records.
boolean	hasPrevious() Verify if DataProvider has previous records.
int	indexOf(T boundObject) Retrieve the index of the given object
boolean	isDirty() Check if this dataProvider has uncommitted modifications.
void	last() Points DataProvider to the last record
void	load() Load the DataProvider data.
protected int	lockRecordForEdition(int recordIndex)
DataProviderRecord<T>	remove(int index) Remove an object from DataProvider
void	removeFilters() Remove all filters form the DataProvider
protected void	replaceTransactionData(Array<DataProviderRecord<T>> transactionRecords)
void	reset() Reset DataProvider, as if it was never loaded before.
void	rollback() Undo all changes
DataProviderRecord<T>	select(int index, boolean selected) Mark the given object as selected
DataProviderRecord<T>	select(T object, boolean selected) Mark the given record as selected
DataProviderRecord<T>	set(int index, T object) Update the DataProvider object at the given index
void	setData(Array<T> data) Method called to bind some data to the DataProvider
void	setData(List<T> data) Method called to bind some data to the DataProvider
void	setData(T[] data) Method called to bind some data to the DataProvider
void	setDataLoader(EagerDataLoader<T> dataLoader) Inform an EagerDataLoader to be used to load data
protected void	setFirstPosition(boolean fireEvents)
DataProviderRecord<T>	setReadOnly(int index, boolean readOnly) Mark the given object as readOnly
DataProviderRecord<T>	setReadOnly(T object, boolean readOnly) Mark the given record as readOnly
int	size() Retrieve the size of the DataProvider set of data
void	sort(Comparator<T> comparator) Sort DataProvider records, using the given comparator
protected void	sortArray(Array<DataProviderRecord<T>> array, Comparator<T> comparator, boolean changePosition)
protected void	update(Array<DataProviderRecord<T>> records)
protected void	updateState(DataProviderRecord<T> record, org.cruxframework.crux.core.client.dataprovider.DataProviderRecord.DataProviderRecordState previousState)

Methods inherited from class org.cruxframework.crux.core.client.dataprovider.AbstractDataProvider

addDataChangedHandler, addDataLoadedHandler, addDataSortedHandler, addLoadStoppedHandler, addResetHandler, addTransactionEndHandler, addTransactionStartHandler, concludeEdition, fireDataChangedEvent, fireLoadedEvent, fireResetEvent, fireSortedEvent, fireStopLoadEvent, fireTransactionEndEvent, fireTransactionStartEvent, get, get, isLoaded, next, previous, read, read, setLoaded, stopLoading

Methods inherited from class java.lang.Object

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

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, next, previous, read, read, remove, reset, rollback, select, select, set, setData, setData, setData, setReadOnly, setReadOnly, sort, stopLoading

Field Detail

dataLoader

protected EagerDataLoader<T> dataLoader

operations

protected org.cruxframework.crux.core.client.dataprovider.DataProviderOperations<T> operations

Constructor Detail

EagerDataProvider

public EagerDataProvider(DataProvider.DataHandler<T> handler)

EagerDataProvider

public EagerDataProvider(DataProvider.DataHandler<T> handler,
                 EagerDataLoader<T> dataLoader)

Method Detail

setDataLoader

public void setDataLoader(EagerDataLoader<T> dataLoader)

Description copied from interface: EagerProvider

Inform an EagerDataLoader to be used to load data

Specified by:

setDataLoader in interface EagerProvider<T>

Parameters:

dataLoader - loader

getDataLoader

public EagerDataLoader<T> getDataLoader()

Description copied from interface: EagerProvider

Retrieve the EagerDataLoader used to load data

Specified by:

getDataLoader in interface EagerProvider<T>

Returns:

loader

load

public void load()

Description copied from interface: DataProvider

Load the DataProvider data.

Specified by:

load in interface DataProvider<T>

addFilter

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

Description copied from interface: FilterableProvider

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

Specified by:

addFilter in interface FilterableProvider<T>

Parameters:

filter - a filter to verify all DataProvider records

Returns:

a registration handler to enable filter removes.

removeFilters

public void removeFilters()

Description copied from interface: FilterableProvider

Remove all filters form the DataProvider

Specified by:

removeFilters in interface FilterableProvider<T>

addDataFilterHandler

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

Description copied from interface: FilterableProvider

Add an handler to be called when filter operations are applied

Specified by:

addDataFilterHandler in interface FilterableProvider<T>

Parameters:

handler - called when filter perform some operation on data

getData

public Array<T> getData()

Description copied from interface: EagerProvider

Retrieve all data loaded into this DataProvider

Specified by:

getData in interface EagerProvider<T>

Returns:

update

protected void update(Array<DataProviderRecord<T>> records)

add

public DataProviderRecord<T> add(int beforeIndex,
                        T object)

Description copied from interface: DataProvider

Insert a new object on DataProvider

Specified by:

add in interface DataProvider<T>

Parameters:

beforeIndex - position to insert

object - element to be insert

Returns:

add

public DataProviderRecord<T> add(T object)

Description copied from interface: DataProvider

Insert a new object on DataProvider

Specified by:

add in interface DataProvider<T>

Parameters:

object - element to be insert

Returns:

commit

public void commit()

Description copied from interface: DataProvider

Confirm all changes

Specified by:

commit in interface DataProvider<T>

filter

public Array<T> filter(DataFilter<T> filter)

Description copied from interface: DataProvider

Return a filtered set of data, applying the given filter to the whole set of data. This operation does not affect the internal set of data. For this purpose, use addFilter instead.

Specified by:

filter in interface DataProvider<T>

Parameters:

filter - filter to apply

Returns:

data filtered

first

public void first()

Description copied from interface: DataProvider

Points DataProvider to first record

Specified by:

first in interface DataProvider<T>

getNewRecords

public DataProviderRecord<T>[] getNewRecords()

Description copied from interface: DataProvider

Return all records inserted on DataProvider

Specified by:

getNewRecords in interface DataProvider<T>

Returns:

all new records

getRecord

public DataProviderRecord<T> getRecord()

Description copied from interface: DataProvider

Return the DataProviderRecord object, representing the current record

Specified by:

getRecord in interface DataProvider<T>

Returns:

current DataProviderRecord object.

getRemovedRecords

public DataProviderRecord<T>[] getRemovedRecords()

Description copied from interface: DataProvider

Return all records removed from DataProvider

Specified by:

getRemovedRecords in interface DataProvider<T>

Returns:

all removed records

getSelectedRecords

public DataProviderRecord<T>[] getSelectedRecords()

Description copied from interface: DataProvider

Return all records selected on DataProvider

Specified by:

getSelectedRecords in interface DataProvider<T>

Returns:

all selected records

getUpdatedRecords

public DataProviderRecord<T>[] getUpdatedRecords()

Description copied from interface: DataProvider

Return all records modified on DataProvider

Specified by:

getUpdatedRecords in interface DataProvider<T>

Returns:

all modified records

hasNext

public boolean hasNext()

Description copied from interface: DataProvider

Verify if DataProvider has more records.

Specified by:

hasNext in interface DataProvider<T>

Returns:

true if more records exist.

hasPrevious

public boolean hasPrevious()

Description copied from interface: DataProvider

Verify if DataProvider has previous records.

Specified by:

hasPrevious in interface DataProvider<T>

Returns:

true if previous records exist.

indexOf

public int indexOf(T boundObject)

Description copied from interface: DataProvider

Retrieve the index of the given object

Specified by:

indexOf in interface DataProvider<T>

Returns:

isDirty

public boolean isDirty()

Description copied from interface: DataProvider

Check if this dataProvider has uncommitted modifications.

Specified by:

isDirty in interface DataProvider<T>

Returns:

true if dirty

last

public void last()

Description copied from interface: MeasurableProvider

Points DataProvider to the last record

Specified by:

last in interface MeasurableProvider<T>

remove

public DataProviderRecord<T> remove(int index)

Description copied from interface: DataProvider

Remove an object from DataProvider

Specified by:

remove in interface DataProvider<T>

Returns:

reset

public void reset()

Description copied from interface: DataProvider

Reset DataProvider, as if it was never loaded before.

Specified by:

reset in interface DataProvider<T>

Overrides:

reset in class AbstractDataProvider<T>

rollback

public void rollback()

Description copied from interface: DataProvider

Undo all changes

Specified by:

rollback in interface DataProvider<T>

select

public DataProviderRecord<T> select(int index,
                           boolean selected)

Description copied from interface: DataProvider

Mark the given object as selected

Specified by:

select in interface DataProvider<T>

Parameters:

index - object position

selected - true if selected

Returns:

select

public DataProviderRecord<T> select(T object,
                           boolean selected)

Description copied from interface: DataProvider

Mark the given record as selected

Specified by:

select in interface DataProvider<T>

Parameters:

object - object to select

selected - true if selected

Returns:

set

public DataProviderRecord<T> set(int index,
                        T object)

Description copied from interface: DataProvider

Update the DataProvider object at the given index

Specified by:

set in interface DataProvider<T>

Parameters:

index - object position

object - new value to set

Returns:

setData

public void setData(Array<T> data)

Description copied from interface: DataProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface DataProvider<T>

setData

public void setData(List<T> data)

Description copied from interface: DataProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface DataProvider<T>

setData

public void setData(T[] data)

Description copied from interface: DataProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface DataProvider<T>

setReadOnly

public DataProviderRecord<T> setReadOnly(int index,
                                boolean readOnly)

Description copied from interface: DataProvider

Mark the given object as readOnly

Specified by:

setReadOnly in interface DataProvider<T>

Parameters:

index - object position

readOnly - true if readOnly

Returns:

setReadOnly

public DataProviderRecord<T> setReadOnly(T object,
                                boolean readOnly)

Description copied from interface: DataProvider

Mark the given record as readOnly

Specified by:

setReadOnly in interface DataProvider<T>

Parameters:

object - object to select

readOnly - true if selected

Returns:

size

public int size()

Description copied from interface: MeasurableProvider

Retrieve the size of the DataProvider set of data

Specified by:

size in interface MeasurableProvider<T>

Returns:

sort

public void sort(Comparator<T> comparator)

Description copied from interface: DataProvider

Sort DataProvider records, using the given comparator

Specified by:

sort in interface DataProvider<T>

Parameters:

comparator - Comparator used for sorting.

changePositionAfterSorting

protected void changePositionAfterSorting()

ensureLoaded

protected void ensureLoaded()

getTransactionRecords

protected Array<DataProviderRecord<T>> getTransactionRecords()

lockRecordForEdition

protected int lockRecordForEdition(int recordIndex)

replaceTransactionData

protected void replaceTransactionData(Array<DataProviderRecord<T>> transactionRecords)

setFirstPosition

protected void setFirstPosition(boolean fireEvents)

sortArray

protected void sortArray(Array<DataProviderRecord<T>> array,
             Comparator<T> comparator,
             boolean changePosition)

updateState

protected void updateState(DataProviderRecord<T> record,
               org.cruxframework.crux.core.client.dataprovider.DataProviderRecord.DataProviderRecordState previousState)

Specified by:

updateState in class AbstractDataProvider<T>