au.com.cybersearch2.classyjpa.entity

Class OrmDaoHelper<T,ID>

java.lang.Object

au.com.cybersearch2.classyjpa.entity.OrmDaoHelper<T,ID>

public class OrmDaoHelper<T,ID>
extends Object

OrmDaoHelper JPA adapter for OrmLite

Author:

Andrew Bowley 02/05/2014

Constructor Summary

Constructors

Constructor and Description
OrmDaoHelper(PersistenceDao<T,ID> entityDao)

Method Summary

Methods

Modifier and Type	Method and Description
int	create(Object object) Persist an object for the first time.
int	delete(Object object) Delete the database row corresponding to the id from the data parameter.
boolean	entityExists(Object object) Returns true if an object exists that matches this ID otherwise false.
ID	extractId(Object object) Returns the ID from the data parameter passed in.
T	queryForId(Object primaryKey) Retrieves an object associated with a specific ID.
T	queryForSameId(Object object) Query for a data item in the table that has the same id as the data parameter.
int	refresh(Object object) Does a query for the data parameter's id and copies in each of the field values from the database to refresh the data parameter.
int	update(Object object) Store the fields from an object to the database row corresponding to the id from the data parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrmDaoHelper

public OrmDaoHelper(PersistenceDao<T,ID> entityDao)

Method Detail

create

public int create(Object object)

Persist an object for the first time. Creates entity table if it does not exist. Uses a PersistenceDao object to perform database operations. @see com.j256.ormlite.dao.PersistenceDao. OrmLite comments: Create a new row in the database from an object. If the object being created uses annotation DatabaseField "generatedId" then the data parameter will be modified and set with the corresponding id from the database.

Parameters:

object - - the entity to be persisted

Returns:

The number of rows updated in the database. This should be 1.

queryForId

public T queryForId(Object primaryKey)

Retrieves an object associated with a specific ID.

Parameters:

primaryKey - Identifier that matches a specific row in the database to find and return.

Returns:

The object that has the ID field which equals id or null if no matches.

Throws:

RuntimeException - on any SQL problems or if more than 1 item with the id are found in the database.

queryForSameId

public T queryForSameId(Object object)

Query for a data item in the table that has the same id as the data parameter.

extractId

public ID extractId(Object object)

Returns the ID from the data parameter passed in. This is used by some of the internal queries to be able to search by id.

entityExists

public boolean entityExists(Object object)

Returns true if an object exists that matches this ID otherwise false.

update

public int update(Object object)

Store the fields from an object to the database row corresponding to the id from the data parameter. If you have made changes to an object, this is how you persist those changes to the database. You cannot use this method to update the id field.

NOTE: This will not save changes made to foreign objects or to foreign collections.

Parameters:

object - The data item that we are updating in the database.

Returns:

The number of rows updated in the database. This should be 1.

Throws:

RuntimeException - on any SQL problems.

IllegalArgumentException - If there is only an ID field in the object.

refresh

public int refresh(Object object)

Does a query for the data parameter's id and copies in each of the field values from the database to refresh the data parameter. Any local object changes to persisted fields will be overwritten. If the database has been updated this brings your local object up to date.

Parameters:

object - The data item that we are refreshing with fields from the database.

Returns:

The number of rows found in the database that correspond to the data id. This should be 1.

Throws:

RuntimeException - on any SQL problems or if the data item is not found in the table or if more than 1 item is found with data's id.

delete

public int delete(Object object)

Delete the database row corresponding to the id from the data parameter.

Parameters:

object - The data item that we are deleting from the database.

Returns:

The number of rows updated in the database. This should be 1.

Throws:

RuntimeException - on any SQL problems.