com.googlecode.genericdao.dao.hibernate.original

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 maxResult limits.
void	create(Object object) Add the specified object as a new entry in the datastore.
boolean	createOrUpdate(Object object) If the id of the object is null or zero, create, otherwise update.
boolean	deleteById(Class<?> klass, Serializable id) Remove the object with the specified id and class from the datastore.
boolean	deleteEntity(Object object) Remove the specified object from the datastore.
<T> T	fetch(Class<T> klass, Serializable id) Get the object with the specified id and class from the datastore.
<T> List<T>	fetchAll(Class<T> klass) 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.
boolean	isConnected(Object object) Returns true if the object is connected to the current Hibernate session.
void	refresh(Object object) Refresh the content of the given entity from the current datastore state.
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 the list of results like search() and the total length like searchLength.
Object	searchUnique(ISearch search) ISearch for a single result using the given parameters.
void	update(Object object) Update the corresponding object in the datastore with the properties of the specified object.

Method Detail

create

void create(Object object)

Add the specified object as a new entry in the datastore.

createOrUpdate

boolean createOrUpdate(Object object)

If the id of the object is null or zero, create, otherwise update.

Returns:

true if create; false if update.

deleteById

boolean deleteById(Class<?> klass,
                 Serializable id)

Remove the object with the specified id and class from the datastore.

Returns:

true if the object is found in the datastore and removed, false if the item is not found.

deleteEntity

boolean deleteEntity(Object object)

Remove the specified object from the datastore.

Returns:

true if the object is found in the datastore and removed, false if the item is not found.

fetch

<T> T fetch(Class<T> klass,
          Serializable id)

Get the object with the specified id and class from the datastore.

fetchAll

<T> List<T> fetchAll(Class<T> klass)

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

update

void update(Object object)

Update the corresponding object in the datastore with the properties of the specified object. The corresponding object is determined by id.

search

List search(ISearch search)

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

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 maxResult limits.

searchAndCount

SearchResult searchAndCount(ISearch search)

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

searchUnique

Object searchUnique(ISearch search)
                    throws org.hibernate.NonUniqueResultException

ISearch for a single result using the given parameters.

Throws:

org.hibernate.NonUniqueResultException

flush

void flush()

Flushes changes in the Hibernate session to the datastore.

isConnected

boolean isConnected(Object object)

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

refresh

void refresh(Object object)

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

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.