nl.qbusict.cupboard.convert

Interface EntityConverter<T>

Type Parameters:

T - the entity type

All Known Implementing Classes:

ReflectiveEntityConverter

public interface EntityConverter<T>

An entity converter is responsible for converting an entity to ContentValues and from a Cursor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntityConverter.Column Holds the column name and type
static class	EntityConverter.ColumnType The SQLite column type

Method Summary

Modifier and Type	Method and Description
T	fromCursor(android.database.Cursor cursor) Create an entity from the cursor.
java.util.List<EntityConverter.Column>	getColumns() Get the database column names along with the colum types
java.lang.Long	getId(T instance) Get the id of an entity
java.lang.String	getTable() Get the database table for the entity
void	setId(java.lang.Long id, T instance) Set the id value on an entity
void	toValues(T object, android.content.ContentValues values) Convert an entity to content values Generally speaking do not add content values for columns that aren't returned from getColumns() and omit columns of value EntityConverter.ColumnType.JOIN

Method Detail

fromCursor

T fromCursor(android.database.Cursor cursor)

Create an entity from the cursor. The cursor supplied is guaranteed to provide the columns in the order returned by getColumns(), but the number of columns might be less if the result does not contain them. For example, if the converter has 10 columns and the cursor has only 7, the columns 0-6 from getColumns() will be supplied, even if the original cursor does not contain all of them. This allows a EntityConverter to iterate over the columns without checking for column name. Note the contract between @{link #getColumns} and this function: getColumns() should always specify the required columns for conversion. Any unlisted columns will be dropped from the cursor that is supplied here for performance reasons.

Parameters:

cursor - the cursor

Returns:

the entity

toValues

void toValues(T object,
              android.content.ContentValues values)

Convert an entity to content values Generally speaking do not add content values for columns that aren't returned from getColumns() and omit columns of value EntityConverter.ColumnType.JOIN

Parameters:

object - the entity

values - the content values to populate

getColumns

java.util.List<EntityConverter.Column> getColumns()

Get the database column names along with the colum types

Returns:

the list of colums

See Also:

EntityConverter.ColumnType

setId

void setId(java.lang.Long id,
           T instance)

Set the id value on an entity

Parameters:

id - the id

instance - the instance to set the id on

getId

java.lang.Long getId(T instance)

Get the id of an entity

Parameters:

instance - the entity

Returns:

the id

getTable

java.lang.String getTable()

Get the database table for the entity

Returns:

the mapped table name