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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentRecord
protected Array<DataProviderRecord<T>>	data
protected Array<DataChangedHandler>	dataChangedHandlers
protected Array<DataLoadedHandler>	dataLoadedHandlers
protected Array<DataLoadStoppedHandler>	dataStopLoadHandlers
protected boolean	loaded
protected Array<TransactionEndHandler>	transactionEndHandlers
protected Array<TransactionStartHandler>	transactionStartHandlers

Constructor Summary

Constructors

Constructor and Description
AbstractDataProvider()

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	addLoadStoppedHandler(DataLoadStoppedHandler handler) Add a callback to be notified about DataProvider loading stop events
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(DataChangedEvent event)
protected void	fireLoadedEvent()
protected void	fireStopLoadEvent()
protected void	fireTransactionEndEvent(boolean commited)
protected void	fireTransactionStartEvent(int firstRecordToLock)
T	get() Return the current record object.
T	get(int index) Return 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	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

dataLoadedHandlers

protected Array<DataLoadedHandler> dataLoadedHandlers

dataStopLoadHandlers

protected Array<DataLoadStoppedHandler> dataStopLoadHandlers

dataChangedHandlers

protected Array<DataChangedHandler> dataChangedHandlers

transactionEndHandlers

protected Array<TransactionEndHandler> transactionEndHandlers

transactionStartHandlers

protected Array<TransactionStartHandler> transactionStartHandlers

data

protected Array<DataProviderRecord<T>> data

currentRecord

protected int currentRecord

loaded

protected boolean loaded

Constructor Detail

AbstractDataProvider

public AbstractDataProvider()

Method Detail

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>

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

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

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

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

get

public T get()

Description copied from interface: DataProvider

Return the current record object.

Specified by:

get in interface DataProvider<T>

Returns:

record object

get

public T get(int index)

Description copied from interface: DataProvider

Return the object referred by the given index

Specified by:

get in interface DataProvider<T>

Parameters:

index - the object position

Returns:

object referred by the given index, or null if there is no object already loaded into this position

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>

setLoaded

protected void setLoaded()

isLoaded

public boolean isLoaded()

Description copied from interface: DataProvider

Check if the DataProvider is loaded

Specified by:

isLoaded in interface DataProvider<T>

Returns:

concludeEdition

protected void concludeEdition(boolean commited)

fireTransactionEndEvent

protected void fireTransactionEndEvent(boolean commited)

fireTransactionStartEvent

protected void fireTransactionStartEvent(int firstRecordToLock)

fireLoadedEvent

protected void fireLoadedEvent()

fireStopLoadEvent

protected void fireStopLoadEvent()

fireDataChangedEvent

protected void fireDataChangedEvent(DataChangedEvent event)

updateState

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