com.threerings.gwt.util

Class ServiceBackedDataModel<T,R>

java.lang.Object

com.threerings.gwt.util.ServiceBackedDataModel<T,R>

All Implemented Interfaces:

DataModel<T>

Direct Known Subclasses:

PagedServiceDataModel

public abstract class ServiceBackedDataModel<T,R>
extends Object
implements DataModel<T>

A data model that can be customized for components that obtain their data by calling a service method to fetch a range of items. Type T is from DataModel, and must be the type that is return in a list from DataModel.doFetchRows. Type R is for the AsyncCallback, and can be anything - it is passed into getCount() and getRows() from the service call.

Constructor Summary

Constructors

Constructor and Description
ServiceBackedDataModel()

Method Summary

Methods

Modifier and Type	Method and Description
void	appendItem(T item) Appends an item to an already loaded model.
void	doFetchRows(int start, int count, AsyncCallback<List<T>> callback) Perform a paged data request for the given number of items at the given offset into the result set.
int	getItemCount() Returns the total number of items in this model.
void	prependItem(T item) Prepends an item to an already loaded model.
void	removeItem(T item) Called when we wish to remove an item from our locally cached data.
void	reset() Clears out any cached data and resets the model to total blankness.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceBackedDataModel

public ServiceBackedDataModel()

Method Detail

prependItem

public void prependItem(T item)

Prepends an item to an already loaded model. The model must have at least been asked to display its first page (and hence have it's total count).

appendItem

public void appendItem(T item)

Appends an item to an already loaded model. The model must have at least been asked to display its first page (and hence have it's total count).

reset

public void reset()

Clears out any cached data and resets the model to total blankness.

getItemCount

public int getItemCount()

Description copied from interface: DataModel

Returns the total number of items in this model. It is OK if this returns zero until after the first call to DataModel.doFetchRows(int, int, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<T>>) is called back. You may also return -1 to indicate that this model does not supply a row count, and the pager should continue offering pages for as long as the underlying service is able to satisfy the requests.

Specified by:

getItemCount in interface DataModel<T>

removeItem

public void removeItem(T item)

Description copied from interface: DataModel

Called when we wish to remove an item from our locally cached data.

Specified by:

removeItem in interface DataModel<T>

doFetchRows

public void doFetchRows(int start,
               int count,
               AsyncCallback<List<T>> callback)

Description copied from interface: DataModel

Perform a paged data request for the given number of items at the given offset into the result set. The result is returned through the given callback.

Specified by:

doFetchRows in interface DataModel<T>