com.googlecode.genericdao.dao.hibernate

Interface GeneralDAO

All Known Implementing Classes:

DAODispatcher, GeneralDAOImpl

public interface GeneralDAO

Interface for general Data Access Object that can be used for any type domain object. A single instance implementing this interface can be used for multiple types of domain objects.

Author:

dwolverton

Method Summary

Methods

Modifier and Type	Method and Description
int	count(ISearch search) Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResults limits.
<T> T[]	find(Class<T> type, Serializable... ids) Get all entities of the specified type from the datastore that have one of these ids.
<T> T	find(Class<T> type, Serializable id) Get the entity with the specified type and id from the datastore.
<T> List<T>	findAll(Class<T> type) Get a list of all the objects of the specified type.
void	flush() Flushes changes in the Hibernate session to the datastore.
Filter	getFilterFromExample(Object example) Generates a search filter from the given example using default options.
Filter	getFilterFromExample(Object example, ExampleOptions options) Generates a search filter from the given example using the specified options.
<T> T	getReference(Class<T> type, Serializable id) Get a reference to the entity with the specified type and id from the datastore.
<T> T[]	getReferences(Class<T> type, Serializable... ids) Get a reference to the entities of the specified type with the given ids from the datastore.
boolean	isAttached(Object entity) Returns true if the object is connected to the current Hibernate session.
void	refresh(Object... entities) Refresh the content of the given entity from the current datastore state.
void	remove(Object... entities) Remove all of the specified entities from the datastore.
boolean	remove(Object entity) Remove the specified entity from the datastore.
boolean	removeById(Class<?> type, Serializable id) Remove the entity with the specified type and id from the datastore.
void	removeByIds(Class<?> type, Serializable... ids) Remove all the entities of the given type from the datastore that have one of these ids.
boolean[]	save(Object... entities) For each entity, if the id of the entity is null or zero, add it to the datastore and assign it an id; otherwise, update the corresponding entity in the datastore with the properties of this entity.
boolean	save(Object entity) If the id of the entity is null or zero, add it to the datastore and assign it an id; otherwise, update the corresponding entity in the datastore with the properties of this entity.
List	search(ISearch search) Search for objects given the search parameters in the specified ISearch object.
SearchResult	searchAndCount(ISearch search) Returns a SearchResult object that includes both the list of results like search() and the total length like count().
Object	searchUnique(ISearch search) Search for a single result using the given parameters.

Method Detail

find

<T> T find(Class<T> type,
         Serializable id)

Get the entity with the specified type and id from the datastore.

If none is found, return null.

find

<T> T[] find(Class<T> type,
           Serializable... ids)

Get all entities of the specified type from the datastore that have one of these ids. An array of entities is returned that matches the same order of the ids listed in the call. For each entity that is not found in the datastore, a null will be inserted in its place in the return array.

getReference

<T> T getReference(Class<T> type,
                 Serializable id)

Get a reference to the entity with the specified type and id from the datastore.

This does not require a call to the datastore and does not populate any of the entity's values. Values may be fetched lazily at a later time. This increases performance if a another entity is being saved that should reference this entity but the values of this entity are not needed.

Throws:

a - HibernateException if no matching entity is found

getReferences

<T> T[] getReferences(Class<T> type,
                    Serializable... ids)

Get a reference to the entities of the specified type with the given ids from the datastore. An array of entities is returned that matches the same order of the ids listed in the call.

This does not require a call to the datastore and does not populate any of the entities' values. Values may be fetched lazily at a later time. This increases performance if a another entity is being saved that should reference these entities but the values of these entities are not needed.

Throws:

a - HibernateException if any of the matching entities are not found.

save

boolean save(Object entity)

If the id of the entity is null or zero, add it to the datastore and assign it an id; otherwise, update the corresponding entity in the datastore with the properties of this entity. In either case the entity passed to this method will be attached to the session.

If an entity to update is already attached to the session, this method will have no effect. If an entity to update has the same id as another instance already attached to the session, an error will be thrown.

Returns:

true if create; false if update.

save

boolean[] save(Object... entities)

For each entity, if the id of the entity is null or zero, add it to the datastore and assign it an id; otherwise, update the corresponding entity in the datastore with the properties of this entity. In either case the entity passed to this method will be attached to the session.

If an entity to update is already attached to the session, this method will have no effect. If an entity to update has the same id as another instance already attached to the session, an error will be thrown.

remove

boolean remove(Object entity)

Remove the specified entity from the datastore.

Returns:

true if the entity is found in the datastore and removed, false if it is not found.

remove

void remove(Object... entities)

Remove all of the specified entities from the datastore.

removeById

boolean removeById(Class<?> type,
                 Serializable id)

Remove the entity with the specified type and id from the datastore.

Returns:

true if the entity is found in the datastore and removed, false if it is not found.

removeByIds

void removeByIds(Class<?> type,
               Serializable... ids)

Remove all the entities of the given type from the datastore that have one of these ids.

findAll

<T> List<T> findAll(Class<T> type)

Get a list of all the objects of the specified type.

search

List search(ISearch search)

Search for objects given the search parameters in the specified ISearch object.

searchUnique

Object searchUnique(ISearch search)

Search for a single result using the given parameters.

count

int count(ISearch search)

Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResults limits.

searchAndCount

SearchResult searchAndCount(ISearch search)

Returns a SearchResult object that includes both the list of results like search() and the total length like count().

isAttached

boolean isAttached(Object entity)

Returns true if the object is connected to the current Hibernate session.

refresh

void refresh(Object... entities)

Refresh the content of the given entity from the current datastore state.

flush

void flush()

Flushes changes in the Hibernate session to the datastore.

getFilterFromExample

Filter getFilterFromExample(Object example)

Generates a search filter from the given example using default options.

getFilterFromExample

Filter getFilterFromExample(Object example,
                          ExampleOptions options)

Generates a search filter from the given example using the specified options.