DataProvider (Crux Core - Development 5.3.2 API)

All Known Subinterfaces:

EagerProvider<T>, FilterableProvider<T>, LazyProvider<T>, MeasurableLazyProvider<T>, MeasurablePagedProvider<T>, MeasurableProvider<E>, PagedDataProvider<T>, StreamingProvider<T>

All Known Implementing Classes:

AbstractDataProvider, EagerDataProvider, EagerPagedDataProvider, LazyDataProvider, StreamingDataProvider
```
public interface DataProvider<T>
```
A DataProvider is used to provide information to widgets that implements HasDataProvider interface, like Crux Grid.

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DataProvider.DataHandler<T>`
`static interface`	`DataProvider.DataReader<T>` DataReaders are used to read and values from a dataProvider.

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`	`addDataChangedHandler(DataChangedHandler callback)` Add a callback to be notified about any changes on data provider
`com.google.gwt.event.shared.HandlerRegistration`	`addDataLoadedHandler(DataLoadedHandler callback)` Add a callback to be notified about DataProvider load events
`com.google.gwt.event.shared.HandlerRegistration`	`addDataSortedHandler(DataSortedHandler callback)` Add a callback to be notified about DataProvider sort events
`com.google.gwt.event.shared.HandlerRegistration`	`addLoadStoppedHandler(DataLoadStoppedHandler callback)` Add a callback to be notified about DataProvider loading stop events
`com.google.gwt.event.shared.HandlerRegistration`	`addResetHandler(ResetHandler callback)` 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
`void`	`commit()` Confirm all changes
`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
`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
`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
`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.
`boolean`	`isLoaded()` Check if the DataProvider is loaded
`void`	`load()` Load the DataProvider data.
`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
`DataProviderRecord<T>`	`remove(int record)` Remove an object from DataProvider
`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
`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
`void`	`stopLoading()` Cancel the loading process, that is asynchronous.

- Method Detail
  - add
```
DataProviderRecord<T> add(int beforeIndex,
                        T object)
```
    Insert a new object on DataProvider
    
    Parameters:
    beforeIndex - position to insert
    object - element to be insert
    
    Returns:
  - add
```
DataProviderRecord<T> add(T object)
```
    Insert a new object on DataProvider
    
    Parameters:
    object - element to be insert
    
    Returns:
  - addResetHandler
```
com.google.gwt.event.shared.HandlerRegistration addResetHandler(ResetHandler callback)
```
    Add a callback to be notified about resets on data provider
    
    Parameters:
    callback - to be called when data provider is reset
    
    Returns:
    a registration that allow handler do be removed
  - addDataChangedHandler
```
com.google.gwt.event.shared.HandlerRegistration addDataChangedHandler(DataChangedHandler callback)
```
    Add a callback to be notified about any changes on data provider
    
    Parameters:
    callback - to be called when data provider is changed
    
    Returns:
    a registration that allow handler do be removed
  - addDataLoadedHandler
```
com.google.gwt.event.shared.HandlerRegistration addDataLoadedHandler(DataLoadedHandler callback)
```
    Add a callback to be notified about DataProvider load events
    
    Parameters:
    callback - to be called when DataProvider is loaded
    
    Returns:
    a registration that allow handler to be removed
  - addDataSortedHandler
```
com.google.gwt.event.shared.HandlerRegistration addDataSortedHandler(DataSortedHandler callback)
```
    Add a callback to be notified about DataProvider sort events
    
    Parameters:
    callback - to be called when DataProvider is sorted
    
    Returns:
    a registration that allow handler to be removed
  - addLoadStoppedHandler
```
com.google.gwt.event.shared.HandlerRegistration addLoadStoppedHandler(DataLoadStoppedHandler callback)
```
    Add a callback to be notified about DataProvider loading stop events
    
    Parameters:
    callback - to be called when DataProvider loading is aborted
    
    Returns:
    a registration that allow handler to be removed
  - addTransactionEndHandler
```
com.google.gwt.event.shared.HandlerRegistration addTransactionEndHandler(TransactionEndHandler handler)
```
    Add a callback to be notified about any transaction executions on data provider
    
    Parameters:
    callback - to be called when data provider transaction is concluded
    
    Returns:
    a registration that allow handler do be removed
  - addTransactionStartHandler
```
com.google.gwt.event.shared.HandlerRegistration addTransactionStartHandler(TransactionStartHandler handler)
```
    Add a callback to be notified about any transaction start on data provider
    
    Parameters:
    callback - to be called when data provider transaction is started
    
    Returns:
    a registration that allow handler do be removed
  - commit
```
void commit()
```
    Confirm all changes
  - filter
```
Array<T> filter(DataFilter<T> filter)
```
    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.
    
    Parameters:
    filter - filter to apply
    
    Returns:
    data filtered
  - first
```
void first()
```
    Points DataProvider to first record
  - get
```
T get()
```
    Retrieve a cloned version of the current record object.
    
    Returns:
    the object retrieved.
  - get
```
T get(int index)
```
    Retrieve a cloned version of the object referred by the given index
    
    Parameters:
    index - the object position
    
    Returns:
    the object retrieved.
  - getNewRecords
```
DataProviderRecord<T>[] getNewRecords()
```
    Return all records inserted on DataProvider
    
    Returns:
    all new records
  - getRecord
```
DataProviderRecord<T> getRecord()
```
    Return the DataProviderRecord object, representing the current record
    
    Returns:
    current DataProviderRecord object.
  - getRemovedRecords
```
DataProviderRecord<T>[] getRemovedRecords()
```
    Return all records removed from DataProvider
    
    Returns:
    all removed records
  - getSelectedRecords
```
DataProviderRecord<T>[] getSelectedRecords()
```
    Return all records selected on DataProvider
    
    Returns:
    all selected records
  - getUpdatedRecords
```
DataProviderRecord<T>[] getUpdatedRecords()
```
    Return all records modified on DataProvider
    
    Returns:
    all modified records
  - hasNext
```
boolean hasNext()
```
    Verify if DataProvider has more records.
    
    Returns:
    true if more records exist.
  - hasPrevious
```
boolean hasPrevious()
```
    Verify if DataProvider has previous records.
    
    Returns:
    true if previous records exist.
  - indexOf
```
int indexOf(T boundObject)
```
    Retrieve the index of the given object
    
    Parameters:
    boundObject -
    
    Returns:
  - isDirty
```
boolean isDirty()
```
    Check if this dataProvider has uncommitted modifications.
    
    Returns:
    true if dirty
  - isLoaded
```
boolean isLoaded()
```
    Check if the DataProvider is loaded
    
    Returns:
  - load
```
void load()
```
    Load the DataProvider data.
  - next
```
void next()
```
    Points DataProvider to next record
  - previous
```
void previous()
```
    Points DataProvider to previous record
  - read
```
void read(DataProvider.DataReader<T> reader)
```
    Read the current record object.
    
    Parameters:
    reader - the reader used to consume the object retrieved.
  - read
```
void read(int index,
        DataProvider.DataReader<T> reader)
```
    Read the object referred by the given index
    
    Parameters:
    index - the object position
    reader - the reader used to consume the object retrieved.
  - remove
```
DataProviderRecord<T> remove(int record)
```
    Remove an object from DataProvider
    
    Parameters:
    record -
    
    Returns:
  - reset
```
void reset()
```
    Reset DataProvider, as if it was never loaded before.
  - rollback
```
void rollback()
```
    Undo all changes
  - select
```
DataProviderRecord<T> select(int index,
                           boolean selected)
```
    Mark the given object as selected
    
    Parameters:
    index - object position
    selected - true if selected
    
    Returns:
  - select
```
DataProviderRecord<T> select(T object,
                           boolean selected)
```
    Mark the given record as selected
    
    Parameters:
    object - object to select
    selected - true if selected
    
    Returns:
  - set
```
DataProviderRecord<T> set(int index,
                        T object)
```
    Update the DataProvider object at the given index
    
    Parameters:
    index - object position
    object - new value to set
    
    Returns:
  - setData
```
void setData(Array<T> data)
```
    Method called to bind some data to the DataProvider
    
    Parameters:
    data -
  - setData
```
void setData(List<T> data)
```
    Method called to bind some data to the DataProvider
    
    Parameters:
    data -
  - setData
```
void setData(T[] data)
```
    Method called to bind some data to the DataProvider
    
    Parameters:
    data -
  - setReadOnly
```
DataProviderRecord<T> setReadOnly(int index,
                                boolean readOnly)
```
    Mark the given object as readOnly
    
    Parameters:
    index - object position
    readOnly - true if readOnly
    
    Returns:
  - setReadOnly
```
DataProviderRecord<T> setReadOnly(T object,
                                boolean readOnly)
```
    Mark the given record as readOnly
    
    Parameters:
    object - object to select
    readOnly - true if selected
    
    Returns:
  - sort
```
void sort(Comparator<T> comparator)
```
    Sort DataProvider records, using the given comparator
    
    Parameters:
    comparator - Comparator used for sorting.
  - stopLoading
```
void stopLoading()
```
    Cancel the loading process, that is asynchronous.

Interface DataProvider<T>

Nested Class Summary

Method Summary

Method Detail

add

add

addResetHandler

addDataChangedHandler

addDataLoadedHandler

addDataSortedHandler

addLoadStoppedHandler

addTransactionEndHandler

addTransactionStartHandler

commit

filter

first

get

get

getNewRecords

getRecord

getRemovedRecords

getSelectedRecords

getUpdatedRecords

hasNext

hasPrevious

indexOf

isDirty

isLoaded

load

next

previous

read

read

remove

reset

rollback

select

select

set

setData

setData

setData

setReadOnly

setReadOnly

sort

stopLoading