nl.qbusict.cupboard

Class CursorCompartment

java.lang.Object

nl.qbusict.cupboard.CursorCompartment

public class CursorCompartment
extends java.lang.Object

CursorCompartment is used to get or iterate results from a Cursor. A CursorCompartment is created from Cupboard.withCursor(Cursor).

Example

  Cursor cursor = ...
  // get the first Book from this cursor
  Book book = cupboard().withCursor(cursor).get(Book.class);
  // iterate all books
  Iterable itr = cupboard().withCursor(cursor).iterate();
  for (Book book : itr) {
    // access book
  }
  

Field Summary

Fields

Modifier and Type	Field and Description
protected Cupboard	mCupboard

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CursorCompartment(Cupboard cupboard, android.database.Cursor cursor)

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.Class<T> clz) Get the first entity from the cursor
protected <T> EntityConverter<T>	getConverter(java.lang.Class<T> clz)
<T> QueryResultIterable<T>	iterate(java.lang.Class<T> clz) Create a Iterable of objects.
<T> java.util.List<T>	list(java.lang.Class<T> clz) Get the contents of this cursor as a list, starting at the current position.

Methods inherited from class java.lang.Object

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

Field Detail

mCupboard

protected final Cupboard mCupboard

Constructor Detail

CursorCompartment

protected CursorCompartment(Cupboard cupboard,
                            android.database.Cursor cursor)

Method Detail

iterate

public <T> QueryResultIterable<T> iterate(java.lang.Class<T> clz)

Create a Iterable of objects.

Parameters:

clz - the entity type

Returns:

the iterable

get

public <T> T get(java.lang.Class<T> clz)

Get the first entity from the cursor

Parameters:

clz - the entity type

Returns:

the object or null if the cursor has no results.

list

public <T> java.util.List<T> list(java.lang.Class<T> clz)

Get the contents of this cursor as a list, starting at the current position. Only to be used if the resultset is to be expected of reasonable size.

Parameters:

clz - the entity type

Returns:

the list of entities obtained from the cursor.

getConverter

protected <T> EntityConverter<T> getConverter(java.lang.Class<T> clz)