nl.qbusict.cupboard.convert

Class ReflectiveEntityConverter<T>

java.lang.Object

nl.qbusict.cupboard.convert.ReflectiveEntityConverter<T>

All Implemented Interfaces:

EntityConverter<T>

public class ReflectiveEntityConverter<T>
extends java.lang.Object
implements EntityConverter<T>

The default EntityConverter

Nested Class Summary

Nested classes/interfaces inherited from interface nl.qbusict.cupboard.convert.EntityConverter

EntityConverter.Column, EntityConverter.ColumnType

Field Summary

Fields

Modifier and Type	Field and Description
protected Cupboard	mCupboard The Cupboard instance for this converter
protected java.lang.Class<T>	mEntityClass

Constructor Summary

Constructors

Constructor and Description
ReflectiveEntityConverter(Cupboard cupboard, java.lang.Class<T> entityClass)
ReflectiveEntityConverter(Cupboard cupboard, java.lang.Class<T> entityClass, java.util.Collection<java.lang.String> ignoredFieldsNames)
ReflectiveEntityConverter(Cupboard cupboard, java.lang.Class<T> entityClass, java.util.Collection<java.lang.String> ignoredFieldNames, java.util.Collection<EntityConverter.Column> additionalColumns) Constructor suitable for EntityConverterFactorys that only need minor changes to the default behavior of this converter, not requiring a sub class.

Method Summary

Modifier and Type	Method and Description
T	fromCursor(android.database.Cursor cursor) Create an entity from the cursor.
protected java.lang.String	getColumn(java.lang.reflect.Field field) Return the column name based on the field supplied.
java.util.List<EntityConverter.Column>	getColumns() Get the database column names along with the colum types
protected FieldConverter<?>	getFieldConverter(java.lang.reflect.Field field) Get a FieldConverter for the specified field.
java.lang.Long	getId(T instance) Get the id of an entity
protected Index	getIndexes(java.lang.reflect.Field field)
java.lang.String	getTable() Get the database table for the entity
protected boolean	isIgnored(java.lang.reflect.Field field) Check if a field should be ignored.
protected boolean	isReadOnlyColumn(java.lang.reflect.Field field) Return if the specified field is read only; meaning that it will never be stored, but only read from if it exists in the database.
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 EntityConverter.getColumns() and omit columns of value EntityConverter.ColumnType.JOIN

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

The Cupboard instance for this converter

mEntityClass

protected final java.lang.Class<T> mEntityClass

Constructor Detail

ReflectiveEntityConverter

public ReflectiveEntityConverter(Cupboard cupboard,
                                 java.lang.Class<T> entityClass)

ReflectiveEntityConverter

public ReflectiveEntityConverter(Cupboard cupboard,
                                 java.lang.Class<T> entityClass,
                                 java.util.Collection<java.lang.String> ignoredFieldsNames)

ReflectiveEntityConverter

public ReflectiveEntityConverter(Cupboard cupboard,
                                 java.lang.Class<T> entityClass,
                                 java.util.Collection<java.lang.String> ignoredFieldNames,
                                 java.util.Collection<EntityConverter.Column> additionalColumns)

Constructor suitable for EntityConverterFactorys that only need minor changes to the default behavior of this converter, not requiring a sub class.

Parameters:

cupboard - the cupboard instance

entityClass - the entity class

ignoredFieldNames - a collection of field names that should be ignored as an alternative to implementing isIgnored(java.lang.reflect.Field)

additionalColumns - a collection of additional columns that will be requested from the cursor

Method Detail

getFieldConverter

protected FieldConverter<?> getFieldConverter(java.lang.reflect.Field field)

Get a FieldConverter for the specified field. This allows for subclasses to provide a specific FieldConverter for a property. The default implementation simply calls Cupboard.getFieldConverter(java.lang.reflect.Type)

Parameters:

field - the field

Returns:

the field converter

isIgnored

protected boolean isIgnored(java.lang.reflect.Field field)

Check if a field should be ignored. This allows subclasses to ignore fields at their discretion.

The default implementation ignores all static, final or transient fields and if Cupboard.isUseAnnotations() returns true also checks for the Ignore annotation.

Parameters:

field - the field

Returns:

true if this field should be ignored, false otherwise

fromCursor

public T fromCursor(android.database.Cursor cursor)

Description copied from interface: EntityConverter

Create an entity from the cursor. The cursor supplied is guaranteed to provide the columns in the order returned by EntityConverter.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 EntityConverter.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: EntityConverter.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.

Specified by:

fromCursor in interface EntityConverter<T>

Parameters:

cursor - the cursor

Returns:

the entity

toValues

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

Description copied from interface: EntityConverter

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

Specified by:

toValues in interface EntityConverter<T>

Parameters:

object - the entity

values - the content values to populate

getColumns

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

Description copied from interface: EntityConverter

Get the database column names along with the colum types

Specified by:

getColumns in interface EntityConverter<T>

Returns:

the list of colums

See Also:

EntityConverter.ColumnType

isReadOnlyColumn

protected boolean isReadOnlyColumn(java.lang.reflect.Field field)

Return if the specified field is read only; meaning that it will never be stored, but only read from if it exists in the database. A read only field will not be created when calling DatabaseCompartment.createTables()

Parameters:

field - the field to check

Returns:

true if this field should be read only (and of EntityConverter.ColumnType.JOIN), false otherwise

setId

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

Description copied from interface: EntityConverter

Set the id value on an entity

Specified by:

setId in interface EntityConverter<T>

Parameters:

id - the id

instance - the instance to set the id on

getId

public java.lang.Long getId(T instance)

Description copied from interface: EntityConverter

Get the id of an entity

Specified by:

getId in interface EntityConverter<T>

Parameters:

instance - the entity

Returns:

the id

getColumn

protected java.lang.String getColumn(java.lang.reflect.Field field)

Return the column name based on the field supplied. If annotation processing is enabled for this converter and the field is annotated with a Column annotation, then the column name is taken from the annotation. In all other cases the column name is simply the name of the field.

Parameters:

field - the entity field

Returns:

the database column name for this field

getIndexes

protected Index getIndexes(java.lang.reflect.Field field)

getTable

public java.lang.String getTable()

Description copied from interface: EntityConverter

Get the database table for the entity

Specified by:

getTable in interface EntityConverter<T>

Returns:

the mapped table name