org.droitateddb

Class EntityService<E>

java.lang.Object

org.droitateddb.EntityService<E>

Type Parameters:

E - Entity, for which this service will be used

Direct Known Subclasses:

ConnectedEntityService

public class EntityService<E>
extends java.lang.Object

Provides support for executing CRUD operations on Entity classes, such getting them from the database or saving them to the database.

Each operation opens a connection to the SQLiteDatabase. If you want only one db connection use ConnectedEntityService

Author:

Falk Appel, Alexander Frank

Field Summary

Fields

Modifier and Type	Field and Description
protected DbCreator	dbCreator

Constructor Summary

Constructors

Constructor and Description
EntityService(android.content.Context context, java.lang.Class<E> entityClass) Creates a EntityService for the given Entity.
EntityService(android.content.Context context, java.lang.Class<E> entityClass, ValidationToggle toggle) Creates a EntityService for the given Entity

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
protected void	closeDB(android.database.sqlite.SQLiteDatabase database)
boolean	delete(E data) Deletes the given Entity from the database
boolean	delete(int id) Deletes the data of the Entity for the given id
java.util.List<E>	find(java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String order) Search for Entitys in the database with basic SQL WHERE statements.
java.util.List<E>	get() Reads all Entitys of the service specific type from the database
E	get(int id) Gets a specific Entity according to the given id
protected android.database.sqlite.SQLiteDatabase	openDB()
void	resolveAssociations(E data) Resolves the associations to a given Entity object and all underlying associations within the object graph.
void	resolveAssociations(E data, int maxDepth) Resolves the associations to a given Entity object.
void	save(java.util.Collection<E> data) Stores all given Entitys in the Collection to the database.
void	save(java.util.Collection<E> data, int maxDepth) Stores all given Entitys in the Collection to the database.
int	save(E data) Stores the given Entity to the database.
int	save(E data, int maxDepth) Stores the given Entity to the database.

Methods inherited from class java.lang.Object

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

Field Detail

dbCreator

protected DbCreator dbCreator

Constructor Detail

EntityService

public EntityService(android.content.Context context,
                     java.lang.Class<E> entityClass)

Creates a EntityService for the given Entity.
The validation when saving Entitys is turned on.

Parameters:

context - Android context

entityClass - Class of the Entity, the service should be used for

Throws:

java.lang.IllegalArgumentException - When the given entityClass is no Entity

EntityService

public EntityService(android.content.Context context,
                     java.lang.Class<E> entityClass,
                     ValidationToggle toggle)

Creates a EntityService for the given Entity

Parameters:

context - Android context

entityClass - Class of the Entity, the service should be used for

toggle - Controls the use of validation on saving Entitys

Throws:

java.lang.IllegalArgumentException - When the given entityClass is no Entity

Method Detail

get

public java.util.List<E> get()

Reads all Entitys of the service specific type from the database

Returns:

All Entitys stored in the database, if non are found a empty list is returned

get

public E get(int id)

Gets a specific Entity according to the given id

Parameters:

id - primary key of the Entity

Returns:

The Entity to the given id, or null if non was found

closeDB

protected void closeDB(android.database.sqlite.SQLiteDatabase database)

openDB

protected android.database.sqlite.SQLiteDatabase openDB()

find

public java.util.List<E> find(java.lang.String selection,
                              java.lang.String[] selectionArgs,
                              java.lang.String order)

Search for Entitys in the database with basic SQL WHERE statements.

Parameters:

selection - SQL WHERE statement

selectionArgs - Arguments for the WHERE statement

order - Sort order of the result

Returns:

All found Entitys or an empty list of non are found

resolveAssociations

public void resolveAssociations(E data)

Resolves the associations to a given Entity object and all underlying associations within the object graph.

Parameters:

data - Entity on which the associations should be resolved

resolveAssociations

public void resolveAssociations(E data,
                                int maxDepth)

Resolves the associations to a given Entity object. The associations will only be resolved to the given depth within the object graph.

Parameters:

data - Entity on which the associations should be resolved

maxDepth - The maximum depth to which the associations should be resolved

save

public int save(E data)

Stores the given Entity to the database. All attached associations will be stored as well.

Parameters:

data - Entity which should be stored

Returns:

The primary key of the given data.

Throws:

java.lang.IllegalStateException - When the PrimaryKey field and its value of the Entity could not be determined

InvalidEntityException - when the given entity is invalid.

save

public int save(E data,
                int maxDepth)

Stores the given Entity to the database. Associated objects will be saved to the given maxDepth.
maxDepth of 0 means that only the given Entity itself will be saved without associations.

Parameters:

data - Entity which should be stored

maxDepth - The maximum depth of the associated objects which should also be saved.

Returns:

The primary key of the given data.

Throws:

java.lang.IllegalStateException - When the PrimaryKey field and its value of the Entity could not be determined

InvalidEntityException - when the given entity is invalid.

save

public void save(java.util.Collection<E> data)

Stores all given Entitys in the Collection to the database. All attached associations will be stored as well.

Parameters:

data - Entitys which should be stored

Throws:

java.lang.IllegalStateException - When the PrimaryKey field and its value of the Entity could not be determined

InvalidEntityException - when at least one of the given entities is invalid.

save

public void save(java.util.Collection<E> data,
                 int maxDepth)

Stores all given Entitys in the Collection to the database. Associated objects will be saved to the given maxDepth.
maxDepth of 0 means that only the given Entity itself will be saved without associations.

Parameters:

data - Entity which should be stored

maxDepth - The maximum depth of the associated objects which should also be saved.

Throws:

java.lang.IllegalStateException - When the PrimaryKey field and its value of the Entity could not be determined

InvalidEntityException - when at least one of the given entities is invalid.

delete

public boolean delete(E data)

Deletes the given Entity from the database

Parameters:

data - Entity that should be deleted

Returns:

true if the Entity could be deleted, false otherwise

Throws:

java.lang.IllegalStateException - When the PrimaryKey field and its value of the Entity could not be determined

java.lang.IllegalArgumentException - When the value of the PrimaryKey field is null

delete

public boolean delete(int id)

Deletes the data of the Entity for the given id

Parameters:

id - primary key of the Entity to be deleted

Returns:

true if the Entity could be deleted, false otherwise

close

@Deprecated
public void close()

Deprecated.

Will be removed with Version 0.2.0
Use ConnectedEntityService if you need only one db connection.