org.cruxframework.crux.core.client.dataprovider

Class StreamingDataProvider<T>

java.lang.Object

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

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

All Implemented Interfaces:

DataProvider<T>, LazyProvider<T>, PagedDataProvider<T>, StreamingProvider<T>

public class StreamingDataProvider<T>
extends AbstractDataProvider<T>
implements StreamingProvider<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	currentPage
protected StreamingDataLoader<T>	dataLoader
protected org.cruxframework.crux.core.client.dataprovider.StreamingDataProviderOperations<T>	operations
protected Array<PageLoadedHandler>	pageFetchHandlers
protected Array<PageRequestedHandler>	pageRequestedHandlers
protected int	pageSize
protected int	previousPage

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
StreamingDataProvider(DataProvider.DataHandler<T> handler)
StreamingDataProvider(DataProvider.DataHandler<T> handler, StreamingDataLoader<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	addPageLoadedHandler(PageLoadedHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addPageRequestedHandler(PageRequestedHandler handler)
protected void	checkChanges()
void	commit() Confirm all changes
protected void	ensureCurrentPageLoaded()
protected void	fetchCurrentPage()
Array<T>	filter(DataFilter<T> filter) Return a filtered set of data, applying the given filter to the whole set of data.
protected void	firePageLoadedEvent(int start, int end)
protected void	firePageRequestedEvent(int pageNumber)
void	first() Points DataProvider to first record
void	firstOnPage()
int	getCurrentPage()
int	getCurrentPageSize()
int	getCurrentPageStartRecord()
StreamingDataLoader<T>	getDataLoader() Retrieve the LazyDataLoader used to load data
DataProviderRecord<T>[]	getNewRecords() Return all records inserted on DataProvider
protected int	getPageEndRecord()
protected int	getPageForRecord(int recordNumber)
int	getPageSize()
protected int	getPageStartRecord()
protected int	getPageStartRecord(int page)
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	hasNextPage()
boolean	hasPrevious() Verify if DataProvider has previous records.
boolean	hasPreviousPage()
int	indexOf(T boundObject) Retrieve the index of the given object
protected boolean	isCurrentPageLoaded()
boolean	isDirty() Check if this dataProvider has uncommitted modifications.
protected boolean	isRecordOnPage(int record)
void	load() Load the DataProvider data.
protected int	lockRecordForEdition(int recordIndex)
boolean	nextPage()
boolean	previousPage()
DataProviderRecord<T>	remove(int index) Remove an object from 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
protected boolean	setCurrentPage(int pageNumber)
void	setData(Array<T> data) Method called to bind some data to the DataProvider
void	setData(Array<T> data, int startRecord) 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(List<T> data, int startRecord) Method called to bind some data to the DataProvider
void	setData(T[] data) Method called to bind some data to the DataProvider
void	setData(T[] data, int startRecord) Method called to bind some data to the DataProvider
void	setDataLoader(StreamingDataLoader<T> dataLoader) Inform an LazyDataLoader to be used to load data
void	setPageSize(int pageSize)
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
void	sort(Comparator<T> comparator) Sort DataProvider records, using the given comparator
protected void	sortArray(Array<DataProviderRecord<T>> array, Comparator<T> comparator)
void	stopLoading() Cancel the loading process, that is asynchronous.
protected void	update(Array<DataProviderRecord<T>> records)
protected void	update(Array<DataProviderRecord<T>> records, int startRecord, int endRecord)
protected void	updateCurrentRecord()
protected int	updatePageRecords(int startRecord, int endRecord, Array<DataProviderRecord<T>> records)
protected int	updateRecords(int startRecord, int endRecord, Array<DataProviderRecord<T>> records)
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

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

addDataChangedHandler, addDataLoadedHandler, addDataSortedHandler, addLoadStoppedHandler, addResetHandler, addTransactionEndHandler, addTransactionStartHandler, get, get, isLoaded, next, previous, read, read

Field Detail

operations

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

pageSize

protected int pageSize

currentPage

protected int currentPage

previousPage

protected int previousPage

pageFetchHandlers

protected Array<PageLoadedHandler> pageFetchHandlers

pageRequestedHandlers

protected Array<PageRequestedHandler> pageRequestedHandlers

dataLoader

protected StreamingDataLoader<T> dataLoader

Constructor Detail

StreamingDataProvider

public StreamingDataProvider(DataProvider.DataHandler<T> handler)

StreamingDataProvider

public StreamingDataProvider(DataProvider.DataHandler<T> handler,
                     StreamingDataLoader<T> dataLoader)

Method Detail

setDataLoader

public void setDataLoader(StreamingDataLoader<T> dataLoader)

Description copied from interface: StreamingProvider

Inform an LazyDataLoader to be used to load data

Specified by:

setDataLoader in interface StreamingProvider<T>

Parameters:

dataLoader - loader

getDataLoader

public StreamingDataLoader<T> getDataLoader()

Description copied from interface: StreamingProvider

Retrieve the LazyDataLoader used to load data

Specified by:

getDataLoader in interface StreamingProvider<T>

Returns:

loader

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

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:

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:

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:

updateState

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

Specified by:

updateState in class AbstractDataProvider<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

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

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

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

rollback

public void rollback()

Description copied from interface: DataProvider

Undo all changes

Specified by:

rollback in interface DataProvider<T>

commit

public void commit()

Description copied from interface: DataProvider

Confirm all changes

Specified by:

commit in interface DataProvider<T>

load

public void load()

Description copied from interface: DataProvider

Load the DataProvider data.

Specified by:

load in interface DataProvider<T>

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:

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:

addPageLoadedHandler

public com.google.gwt.event.shared.HandlerRegistration addPageLoadedHandler(PageLoadedHandler handler)

Specified by:

addPageLoadedHandler in interface PagedDataProvider<T>

addPageRequestedHandler

public com.google.gwt.event.shared.HandlerRegistration addPageRequestedHandler(PageRequestedHandler handler)

Specified by:

addPageRequestedHandler in interface PagedDataProvider<T>

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:

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:

stopLoading

public void stopLoading()

Description copied from interface: DataProvider

Cancel the loading process, that is asynchronous.

Specified by:

stopLoading in interface DataProvider<T>

Overrides:

stopLoading in class AbstractDataProvider<T>

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.

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.

first

public void first()

Description copied from interface: DataProvider

Points DataProvider to first record

Specified by:

first in interface DataProvider<T>

firstOnPage

public void firstOnPage()

Specified by:

firstOnPage in interface PagedDataProvider<T>

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.

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>

getCurrentPage

public int getCurrentPage()

Specified by:

getCurrentPage in interface PagedDataProvider<T>

getCurrentPageSize

public int getCurrentPageSize()

Specified by:

getCurrentPageSize in interface PagedDataProvider<T>

getCurrentPageStartRecord

public int getCurrentPageStartRecord()

Specified by:

getCurrentPageStartRecord in interface PagedDataProvider<T>

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface PagedDataProvider<T>

hasNextPage

public boolean hasNextPage()

Specified by:

hasNextPage in interface PagedDataProvider<T>

hasPreviousPage

public boolean hasPreviousPage()

Specified by:

hasPreviousPage in interface PagedDataProvider<T>

nextPage

public boolean nextPage()

Specified by:

nextPage in interface PagedDataProvider<T>

previousPage

public boolean previousPage()

Specified by:

previousPage in interface PagedDataProvider<T>

setCurrentPage

protected boolean setCurrentPage(int pageNumber)

setPageSize

public void setPageSize(int pageSize)

Specified by:

setPageSize in interface PagedDataProvider<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>

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(Array<T> data)

Description copied from interface: DataProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface DataProvider<T>

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.

setData

public void setData(T[] data,
           int startRecord)

Description copied from interface: LazyProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface LazyProvider<T>

Parameters:

data - fragment data

startRecord - the start position of the fragment

setData

public void setData(List<T> data,
           int startRecord)

Description copied from interface: LazyProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface LazyProvider<T>

Parameters:

data - fragment data

startRecord - the start position of the fragment

setData

public void setData(Array<T> data,
           int startRecord)

Description copied from interface: LazyProvider

Method called to bind some data to the DataProvider

Specified by:

setData in interface LazyProvider<T>

Parameters:

data - fragment data

startRecord - the start position of the fragment

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

ensureCurrentPageLoaded

protected void ensureCurrentPageLoaded()

isCurrentPageLoaded

protected boolean isCurrentPageLoaded()

isRecordOnPage

protected boolean isRecordOnPage(int record)

getPageEndRecord

protected int getPageEndRecord()

getPageStartRecord

protected int getPageStartRecord()

getPageStartRecord

protected int getPageStartRecord(int page)

sortArray

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

updateCurrentRecord

protected void updateCurrentRecord()

fetchCurrentPage

protected void fetchCurrentPage()

firePageLoadedEvent

protected void firePageLoadedEvent(int start,
                       int end)

firePageRequestedEvent

protected void firePageRequestedEvent(int pageNumber)

update

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

update

protected void update(Array<DataProviderRecord<T>> records,
          int startRecord,
          int endRecord)

updateRecords

protected int updateRecords(int startRecord,
                int endRecord,
                Array<DataProviderRecord<T>> records)

updatePageRecords

protected int updatePageRecords(int startRecord,
                    int endRecord,
                    Array<DataProviderRecord<T>> records)

checkChanges

protected void checkChanges()

getTransactionRecords

protected Array<DataProviderRecord<T>> getTransactionRecords()

replaceTransactionData

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

lockRecordForEdition

protected int lockRecordForEdition(int recordIndex)

getPageForRecord

protected int getPageForRecord(int recordNumber)