org.appfuse.dao

Interface GenericDao<T,PK extends Serializable>

Type Parameters:

T - a type variable

PK - the primary key for that type

All Known Subinterfaces:

RoleDao, UserDao

All Known Implementing Classes:

GenericDaoHibernate, RoleDaoHibernate, UserDaoHibernate

public interface GenericDao<T,PK extends Serializable>

Generic DAO (Data Access Object) with common methods to CRUD POJOs.

Extend this interface if you want typesafe (no casting necessary) DAO's for your domain objects.

Author:

Bryan Noll, jgarcia (update: added full text search + reindexing)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists(PK id) Checks for existence of an object of type T using the id arg.
List<T>	findByNamedQuery(String queryName, Map<String,Object> queryParams) Find a list of records by using a named query
T	get(PK id) Generic method to get an object based on class and identifier.
List<T>	getAll() Generic method used to get all objects of a particular type.
List<T>	getAllDistinct() Gets all records without duplicates.
void	reindex() Generic method to regenerate full text index of the persistent class T
void	reindexAll(boolean async) Generic method to regenerate full text index of all indexed classes
void	remove(PK id) Generic method to delete an object
void	remove(T object) Generic method to delete an object
T	save(T object) Generic method to save an object - handles both update and insert.
List<T>	search(String searchTerm) Gets all records that match a search term.

Method Detail

getAll

List<T> getAll()

Generic method used to get all objects of a particular type. This is the same as lookup up all rows in a table.

Returns:

List of populated objects

getAllDistinct

List<T> getAllDistinct()

Gets all records without duplicates.

Note that if you use this method, it is imperative that your model classes correctly implement the hashcode/equals methods

Returns:

List of populated objects

search

List<T> search(String searchTerm)
               throws SearchException

Gets all records that match a search term. "*" will get them all.

Parameters:

searchTerm - the term to search for

Returns:

the matching records

Throws:

SearchException

get

T get(PK id)

Generic method to get an object based on class and identifier. An ObjectRetrievalFailureException Runtime Exception is thrown if nothing is found.

Parameters:

id - the identifier (primary key) of the object to get

Returns:

a populated object

See Also:

ObjectRetrievalFailureException

exists

boolean exists(PK id)

Checks for existence of an object of type T using the id arg.

Parameters:

id - the id of the entity

Returns:

- true if it exists, false if it doesn't

save

T save(T object)

Generic method to save an object - handles both update and insert.

Parameters:

object - the object to save

Returns:

the persisted object

remove

void remove(T object)

Generic method to delete an object

Parameters:

object - the object to remove

remove

void remove(PK id)

Generic method to delete an object

Parameters:

id - the identifier (primary key) of the object to remove

findByNamedQuery

List<T> findByNamedQuery(String queryName,
                       Map<String,Object> queryParams)

Find a list of records by using a named query

Parameters:

queryName - query name of the named query

queryParams - a map of the query names and the values

Returns:

a list of the records found

reindex

void reindex()

Generic method to regenerate full text index of the persistent class T

reindexAll

void reindexAll(boolean async)

Generic method to regenerate full text index of all indexed classes

Parameters:

async - true to perform the reindexing asynchronously