org.cruxframework.crux.core.client.dataprovider

Class AbstractDataProvider<T>

java.lang.Object

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

All Implemented Interfaces:

DataProvider<T>

Direct Known Subclasses:

EagerDataProvider, EagerPagedDataProvider, LazyDataProvider, StreamingDataProvider

public abstract class AbstractDataProvider<T>
extends Object
implements DataProvider<T>

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

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 int	currentRecord
protected Array<DataProviderRecord<T>>	data
protected Array<DataChangedHandler>	dataChangedHandlers
protected DataProvider.DataHandler<T>	dataHandler
protected Array<DataLoadedHandler>	dataLoadedHandlers
protected Array<DataSortedHandler>	dataSortedHandlers
protected Array<DataLoadStoppedHandler>	dataStopLoadHandlers
protected boolean	loaded
protected Array<ResetHandler>	resetHandlers
protected Array<TransactionEndHandler>	transactionEndHandlers
protected Array<TransactionStartHandler>	transactionStartHandlers

Constructor Summary

Constructors

Constructor and Description
AbstractDataProvider(DataProvider.DataHandler<T> handler)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addDataChangedHandler(DataChangedHandler handler) Add a callback to be notified about any changes on data provider
com.google.gwt.event.shared.HandlerRegistration	addDataLoadedHandler(DataLoadedHandler handler) Add a callback to be notified about DataProvider load events
com.google.gwt.event.shared.HandlerRegistration	addDataSortedHandler(DataSortedHandler handler) Add a callback to be notified about DataProvider sort events
com.google.gwt.event.shared.HandlerRegistration	addLoadStoppedHandler(DataLoadStoppedHandler handler) Add a callback to be notified about DataProvider loading stop events
com.google.gwt.event.shared.HandlerRegistration	addResetHandler(ResetHandler handler) Add a callback to be notified about resets on data provider
com.google.gwt.event.shared.HandlerRegistration	addTransactionEndHandler(TransactionEndHandler handler) Add a callback to be notified about any transaction executions on data provider
com.google.gwt.event.shared.HandlerRegistration	addTransactionStartHandler(TransactionStartHandler handler) Add a callback to be notified about any transaction start on data provider
protected void	concludeEdition(boolean commited)
protected void	fireDataChangedEvent(DataProviderRecord<?> currentRecord, int recordPosition)
protected void	fireLoadedEvent()
protected void	fireResetEvent()
protected void	fireSortedEvent(boolean pageChanged)
protected void	fireStopLoadEvent()
protected void	fireTransactionEndEvent(boolean commited)
protected void	fireTransactionStartEvent(int firstRecordToLock)
T	get() Retrieve a cloned version of the current record object.
T	get(int index) Retrieve a cloned version of the object referred by the given index
boolean	isLoaded() Check if the DataProvider is loaded
void	next() Points DataProvider to next record
void	previous() Points DataProvider to previous record
void	read(DataProvider.DataReader<T> reader) Read the current record object.
void	read(int index, DataProvider.DataReader<T> reader) Read the object referred by the given index
void	reset() Reset DataProvider, as if it was never loaded before.
protected void	setLoaded()
void	stopLoading() Cancel the loading process, that is asynchronous.
protected abstract void	updateState(DataProviderRecord<T> record, org.cruxframework.crux.core.client.dataprovider.DataProviderRecord.DataProviderRecordState previousState)

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, commit, filter, first, getNewRecords, getRecord, getRemovedRecords, getSelectedRecords, getUpdatedRecords, hasNext, hasPrevious, indexOf, isDirty, load, remove, rollback, select, select, set, setData, setData, setData, setReadOnly, setReadOnly, sort

Field Detail

currentRecord

protected int currentRecord

data

protected Array<DataProviderRecord<T>> data

dataChangedHandlers

protected Array<DataChangedHandler> dataChangedHandlers

resetHandlers

protected Array<ResetHandler> resetHandlers

dataHandler

protected DataProvider.DataHandler<T> dataHandler

dataLoadedHandlers

protected Array<DataLoadedHandler> dataLoadedHandlers

dataSortedHandlers

protected Array<DataSortedHandler> dataSortedHandlers

dataStopLoadHandlers

protected Array<DataLoadStoppedHandler> dataStopLoadHandlers

loaded

protected boolean loaded

transactionEndHandlers

protected Array<TransactionEndHandler> transactionEndHandlers

transactionStartHandlers

protected Array<TransactionStartHandler> transactionStartHandlers

Constructor Detail

AbstractDataProvider

public AbstractDataProvider(DataProvider.DataHandler<T> handler)

Method Detail

addDataChangedHandler

public com.google.gwt.event.shared.HandlerRegistration addDataChangedHandler(DataChangedHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about any changes on data provider

Specified by:

addDataChangedHandler in interface DataProvider<T>

Parameters:

handler - to be called when data provider is changed

Returns:

a registration that allow handler do be removed

addResetHandler

public com.google.gwt.event.shared.HandlerRegistration addResetHandler(ResetHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about resets on data provider

Specified by:

addResetHandler in interface DataProvider<T>

Parameters:

handler - to be called when data provider is reset

Returns:

a registration that allow handler do be removed

addDataLoadedHandler

public com.google.gwt.event.shared.HandlerRegistration addDataLoadedHandler(DataLoadedHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about DataProvider load events

Specified by:

addDataLoadedHandler in interface DataProvider<T>

Parameters:

handler - to be called when DataProvider is loaded

Returns:

a registration that allow handler to be removed

addDataSortedHandler

public com.google.gwt.event.shared.HandlerRegistration addDataSortedHandler(DataSortedHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about DataProvider sort events

Specified by:

addDataSortedHandler in interface DataProvider<T>

Parameters:

handler - to be called when DataProvider is sorted

Returns:

a registration that allow handler to be removed

addLoadStoppedHandler

public com.google.gwt.event.shared.HandlerRegistration addLoadStoppedHandler(DataLoadStoppedHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about DataProvider loading stop events

Specified by:

addLoadStoppedHandler in interface DataProvider<T>

Parameters:

handler - to be called when DataProvider loading is aborted

Returns:

a registration that allow handler to be removed

addTransactionEndHandler

public com.google.gwt.event.shared.HandlerRegistration addTransactionEndHandler(TransactionEndHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about any transaction executions on data provider

Specified by:

addTransactionEndHandler in interface DataProvider<T>

Returns:

a registration that allow handler do be removed

addTransactionStartHandler

public com.google.gwt.event.shared.HandlerRegistration addTransactionStartHandler(TransactionStartHandler handler)

Description copied from interface: DataProvider

Add a callback to be notified about any transaction start on data provider

Specified by:

addTransactionStartHandler in interface DataProvider<T>

Returns:

a registration that allow handler do be removed

get

public T get()

Description copied from interface: DataProvider

Retrieve a cloned version of the current record object.

Specified by:

get in interface DataProvider<T>

Returns:

the object retrieved.

get

public T get(int index)

Description copied from interface: DataProvider

Retrieve a cloned version of the object referred by the given index

Specified by:

get in interface DataProvider<T>

Parameters:

index - the object position

Returns:

the object retrieved.

isLoaded

public boolean isLoaded()

Description copied from interface: DataProvider

Check if the DataProvider is loaded

Specified by:

isLoaded in interface DataProvider<T>

Returns:

next

public void next()

Description copied from interface: DataProvider

Points DataProvider to next record

Specified by:

next in interface DataProvider<T>

previous

public void previous()

Description copied from interface: DataProvider

Points DataProvider to previous record

Specified by:

previous in interface DataProvider<T>

read

public void read(DataProvider.DataReader<T> reader)

Description copied from interface: DataProvider

Read the current record object.

Specified by:

read in interface DataProvider<T>

Parameters:

reader - the reader used to consume the object retrieved.

read

public void read(int index,
        DataProvider.DataReader<T> reader)

Description copied from interface: DataProvider

Read the object referred by the given index

Specified by:

read in interface DataProvider<T>

Parameters:

index - the object position

reader - the reader used to consume the object retrieved.

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>

stopLoading

public void stopLoading()

Description copied from interface: DataProvider

Cancel the loading process, that is asynchronous.

Specified by:

stopLoading in interface DataProvider<T>

concludeEdition

protected void concludeEdition(boolean commited)

fireDataChangedEvent

protected void fireDataChangedEvent(DataProviderRecord<?> currentRecord,
                        int recordPosition)

fireResetEvent

protected void fireResetEvent()

fireLoadedEvent

protected void fireLoadedEvent()

fireSortedEvent

protected void fireSortedEvent(boolean pageChanged)

fireStopLoadEvent

protected void fireStopLoadEvent()

fireTransactionEndEvent

protected void fireTransactionEndEvent(boolean commited)

fireTransactionStartEvent

protected void fireTransactionStartEvent(int firstRecordToLock)

setLoaded

protected void setLoaded()

updateState

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