Summary: Nested Classes | Ctors | Methods | Inherited Methods

PositionalDataSource

The android.arch Architecture Components packages are no longer maintained. They have been superseded by the corresponding androidx.* packages. See androidx.paging.PositionalDataSource instead.

public abstract class PositionalDataSource
extends DataSource<Integer, T>

java.lang.Object
↳	android.arch.paging.DataSource<java.lang.Integer, T>
	↳	android.arch.paging.PositionalDataSource<T>

Position-based data loader for a fixed-size, countable data set, supporting fixed-size loads at arbitrary page positions.

Extend PositionalDataSource if you can load pages of a requested size at arbitrary positions, and provide a fixed item count. If your data source can't support loading arbitrary requested page sizes (e.g. when network page size constraints are only known at runtime), use either PageKeyedDataSource or ItemKeyedDataSource instead.

Note that unless placeholders are disabled PositionalDataSource requires counting the size of the data set. This allows pages to be tiled in at arbitrary, non-contiguous locations based upon what the user observes in a PagedList. If placeholders are disabled, initialize with the two parameter onResult(List, int).

Room can generate a Factory of PositionalDataSources for you:

 @Dao
 interface UserDao {
     @Query("SELECT * FROM user ORDER BY mAge DESC")
     public abstract DataSource.Factory<Integer, User> loadUsersByAgeDesc();
 }

Summary

Nested classes
`class`	`PositionalDataSource.LoadInitialCallback<T>` Callback for `loadInitial(LoadInitialParams, LoadInitialCallback)` to return data, position, and count.
`class`	`PositionalDataSource.LoadInitialParams` Holder object for inputs to `loadInitial(LoadInitialParams, LoadInitialCallback)`.
`class`	`PositionalDataSource.LoadRangeCallback<T>` Callback for PositionalDataSource `loadRange(LoadRangeParams, LoadRangeCallback)` to return data.
`class`	`PositionalDataSource.LoadRangeParams` Holder object for inputs to `loadRange(LoadRangeParams, LoadRangeCallback)`.

Public constructors
`PositionalDataSource()`

Public methods
`static int`	`computeInitialLoadPosition(PositionalDataSource.LoadInitialParams params, int totalCount)` Helper for computing an initial position in `loadInitial(LoadInitialParams, LoadInitialCallback)` when total data set size can be computed ahead of loading.
`static int`	`computeInitialLoadSize(PositionalDataSource.LoadInitialParams params, int initialLoadPosition, int totalCount)` Helper for computing an initial load size in `loadInitial(LoadInitialParams, LoadInitialCallback)` when total data set size can be computed ahead of loading.
`abstract void`	`loadInitial(PositionalDataSource.LoadInitialParams params, LoadInitialCallback<T> callback)` Load initial list data.
`abstract void`	`loadRange(PositionalDataSource.LoadRangeParams params, LoadRangeCallback<T> callback)` Called to load a range of data from the DataSource.
`final <V> PositionalDataSource<V>`	`map(Function<T, V> function)` Applies the given function to each value emitted by the DataSource.
`final <V> PositionalDataSource<V>`	`mapByPage(Function<List<T>, List<V>> function)` Applies the given function to each value emitted by the DataSource.

Inherited methods

From class


        
          android.arch.paging.DataSource

`void`	`addInvalidatedCallback(DataSource.InvalidatedCallback onInvalidatedCallback)` Add a callback to invoke when the DataSource is first invalidated.
`void`	`invalidate()` Signal the data source to stop loading, and notify its callback.
`boolean`	`isInvalid()` Returns true if the data source is invalid, and can no longer be queried for data.
`abstract <ToValue> DataSource<Integer, ToValue>`	`map(Function<T, ToValue> function)` Applies the given function to each value emitted by the DataSource.
`abstract <ToValue> DataSource<Integer, ToValue>`	`mapByPage(Function<List<T>, List<ToValue>> function)` Applies the given function to each value emitted by the DataSource.
`void`	`removeInvalidatedCallback(DataSource.InvalidatedCallback onInvalidatedCallback)` Remove a previously added invalidate callback.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

PositionalDataSource

PositionalDataSource ()

Public methods

computeInitialLoadPosition

int computeInitialLoadPosition (PositionalDataSource.LoadInitialParams params, 
                int totalCount)

Helper for computing an initial position in loadInitial(LoadInitialParams, LoadInitialCallback) when total data set size can be computed ahead of loading.

The value computed by this function will do bounds checking, page alignment, and positioning based on initial load size requested.

Example usage in a PositionalDataSource subclass:

 class ItemDataSource extends PositionalDataSource<Item> {
     private int computeCount() {
         // actual count code here
     }

     private List<Item> loadRangeInternal(int startPosition, int loadCount) {
         // actual load code here
     }

     @Override
     public void loadInitial(@NonNull LoadInitialParams params,
             @NonNull LoadInitialCallback<Item> callback) {
         int totalCount = computeCount();
         int position = computeInitialLoadPosition(params, totalCount);
         int loadSize = computeInitialLoadSize(params, position, totalCount);
         callback.onResult(loadRangeInternal(position, loadSize), position, totalCount);
     }

     @Override
     public void loadRange(@NonNull LoadRangeParams params,
             @NonNull LoadRangeCallback<Item> callback) {
         callback.onResult(loadRangeInternal(params.startPosition, params.loadSize));
     }
 }

Parameters
`params`	`PositionalDataSource.LoadInitialParams`: Params passed to `loadInitial(LoadInitialParams, LoadInitialCallback)`, including page size, and requested start/loadSize.
`totalCount`	`int`: Total size of the data set.

Returns
`int`	Position to start loading at.

See also:

computeInitialLoadSize(LoadInitialParams, int, int)

computeInitialLoadSize

int computeInitialLoadSize (PositionalDataSource.LoadInitialParams params, 
                int initialLoadPosition, 
                int totalCount)

Helper for computing an initial load size in loadInitial(LoadInitialParams, LoadInitialCallback) when total data set size can be computed ahead of loading.

This function takes the requested load size, and bounds checks it against the value returned by computeInitialLoadPosition(LoadInitialParams, int).

Example usage in a PositionalDataSource subclass:

 class ItemDataSource extends PositionalDataSource<Item> {
     private int computeCount() {
         // actual count code here
     }

     private List<Item> loadRangeInternal(int startPosition, int loadCount) {
         // actual load code here
     }

     @Override
     public void loadInitial(@NonNull LoadInitialParams params,
             @NonNull LoadInitialCallback<Item> callback) {
         int totalCount = computeCount();
         int position = computeInitialLoadPosition(params, totalCount);
         int loadSize = computeInitialLoadSize(params, position, totalCount);
         callback.onResult(loadRangeInternal(position, loadSize), position, totalCount);
     }

     @Override
     public void loadRange(@NonNull LoadRangeParams params,
             @NonNull LoadRangeCallback<Item> callback) {
         callback.onResult(loadRangeInternal(params.startPosition, params.loadSize));
     }
 }

Parameters
`params`	`PositionalDataSource.LoadInitialParams`: Params passed to `loadInitial(LoadInitialParams, LoadInitialCallback)`, including page size, and requested start/loadSize.
`initialLoadPosition`	`int`: Value returned by `computeInitialLoadPosition(LoadInitialParams, int)`
`totalCount`	`int`: Total size of the data set.

Returns
`int`	Number of items to load.

See also:

computeInitialLoadPosition(LoadInitialParams, int)

loadInitial

void loadInitial (PositionalDataSource.LoadInitialParams params, 
                LoadInitialCallback<T> callback)

Load initial list data.

This method is called to load the initial page(s) from the DataSource.

Result list must be a multiple of pageSize to enable efficient tiling.

Parameters
`params`	`PositionalDataSource.LoadInitialParams`: Parameters for initial load, including requested start position, load size, and page size.
`callback`	`LoadInitialCallback`: Callback that receives initial load data, including position and total data set size.

loadRange

void loadRange (PositionalDataSource.LoadRangeParams params, 
                LoadRangeCallback<T> callback)

Called to load a range of data from the DataSource.

This method is called to load additional pages from the DataSource after the LoadInitialCallback passed to dispatchLoadInitial has initialized a PagedList.

Unlike loadInitial(LoadInitialParams, LoadInitialCallback), this method must return the number of items requested, at the position requested.

Parameters
`params`	`PositionalDataSource.LoadRangeParams`: Parameters for load, including start position and load size.
`callback`	`LoadRangeCallback`: Callback that receives loaded data.

map

PositionalDataSource<V> map (Function<T, V> function)

Applies the given function to each value emitted by the DataSource.

Same as mapByPage(Function), but operates on individual items.

Parameters
`function`	`Function`: Function that runs on each loaded item, returning items of a potentially new type.

Returns
`PositionalDataSource<V>`	A new DataSource, which transforms items using the given function.

mapByPage

PositionalDataSource<V> mapByPage (Function<List<T>, List<V>> function)

Applies the given function to each value emitted by the DataSource.

Same as map(Function), but allows for batch conversions.

Parameters
`function`	`Function`: Function that runs on each loaded page, returning items of a potentially new type.

Returns
`PositionalDataSource<V>`	A new DataSource, which transforms items using the given function.

PositionalDataSource

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

PositionalDataSource

Public methods

computeInitialLoadPosition

computeInitialLoadSize

loadInitial

loadRange

map

mapByPage

Interfaces

Classes