io.requery.android

Class QueryRecyclerAdapter<E,VH extends RecyclerView.ViewHolder>

java.lang.Object

<any>

io.requery.android.QueryRecyclerAdapter<E,VH>

Type Parameters:

E - entity element type

VH - view holder type

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class QueryRecyclerAdapter<E,VH extends RecyclerView.ViewHolder>
extends <any>
implements java.io.Closeable

An implementation of android.support.v7.widget.RecyclerView.Adapter specifically for displaying items from a EntityDataStore query. To use extend this class and implement performQuery() and onBindViewHolder(Object, RecyclerView.ViewHolder, int).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryRecyclerAdapter() Creates a new adapter instance without any type mapping.
protected	QueryRecyclerAdapter(io.requery.meta.EntityModel model, java.lang.Class<E> type) Creates a new adapter instance.
protected	QueryRecyclerAdapter(io.requery.meta.Type<E> type) Creates a new adapter instance mapped to the given type.

Method Summary

Modifier and Type	Method and Description
void	close() Call this to clean up the underlying result.
int	getItemCount()
long	getItemId(int position)
protected int	getItemViewType(E item) Return the view type of the item.
int	getItemViewType(int position)
protected io.requery.sql.ResultSetIterator<E>	getIterator()
abstract void	onBindViewHolder(E item, VH holder, int position) Called to display the data at the specified position for the given item.
void	onBindViewHolder(VH holder, int position)
void	onDetachedFromRecyclerView(RecyclerView recyclerView)
abstract io.requery.query.Result<E>	performQuery() Implement this method with your query operation.
void	queryAsync() Schedules the query to be run in the background.
void	setExecutor(java.util.concurrent.ExecutorService executor) Sets the Executor used for running the query off the main thread.
void	setResult(io.requery.sql.ResultSetIterator<E> iterator) Sets the results the adapter should display.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryRecyclerAdapter

protected QueryRecyclerAdapter(io.requery.meta.EntityModel model,
                               java.lang.Class<E> type)

Creates a new adapter instance.

Parameters:

model - database entity model

type - entity class type

QueryRecyclerAdapter

protected QueryRecyclerAdapter()

Creates a new adapter instance without any type mapping.

QueryRecyclerAdapter

protected QueryRecyclerAdapter(io.requery.meta.Type<E> type)

Creates a new adapter instance mapped to the given type.

Parameters:

type - entity type

Method Detail

close

public void close()

Call this to clean up the underlying result.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getIterator

protected io.requery.sql.ResultSetIterator<E> getIterator()

Returns:

the underlying iterator being used or null if none

setExecutor

public void setExecutor(java.util.concurrent.ExecutorService executor)

Sets the Executor used for running the query off the main thread.

Parameters:

executor - ExecutorService to use for the background query.

setResult

public void setResult(io.requery.sql.ResultSetIterator<E> iterator)

Sets the results the adapter should display.

Parameters:

iterator - result set iterator

queryAsync

public void queryAsync()

Schedules the query to be run in the background. After completion setResult(ResultSetIterator) will be called to update the contents of the adapter. Note if an Executor was not specified one will be created automatically to run the query.

performQuery

public abstract io.requery.query.Result<E> performQuery()

Implement this method with your query operation. Note this method is executed on a background thread not the main thread.

Returns:

query result set

See Also:

setExecutor(ExecutorService)

onBindViewHolder

public void onBindViewHolder(VH holder,
                             int position)

onBindViewHolder

public abstract void onBindViewHolder(E item,
                                      VH holder,
                                      int position)

Called to display the data at the specified position for the given item. The item is retrieved from the result iterator.

Parameters:

item - entity element to bind to the view

holder - view holder to be updated

position - position index of the view

getItemId

public long getItemId(int position)

getItemCount

public int getItemCount()

getItemViewType

public int getItemViewType(int position)

getItemViewType

protected int getItemViewType(E item)

Return the view type of the item.

Parameters:

item - being checked

Returns:

integer identifying the type of the view

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(RecyclerView recyclerView)