org.appfuse.service.impl

Class GenericManagerImpl<T,PK extends Serializable>

java.lang.Object

org.appfuse.service.impl.GenericManagerImpl<T,PK>

Type Parameters:

T - a type variable

PK - the primary key for that type

All Implemented Interfaces:

GenericManager<T,PK>

Direct Known Subclasses:

RoleManagerImpl, UserManagerImpl

public class GenericManagerImpl<T,PK extends Serializable>
extends Object
implements GenericManager<T,PK>

This class serves as the Base class for all other Managers - namely to hold common CRUD methods that they might all use. You should only need to extend this class when your require custom CRUD logic.

To register this class in your Spring context file, use the following XML.

     <bean id="userManager" class="org.appfuse.service.impl.GenericManagerImpl">
         <constructor-arg>
             <bean class="org.appfuse.dao.hibernate.GenericDaoHibernate">
                 <constructor-arg value="org.appfuse.model.User"/>
                 <property name="sessionFactory" ref="sessionFactory"/>
             </bean>
         </constructor-arg>
     </bean>
 

If you're using iBATIS instead of Hibernate, use:

     <bean id="userManager" class="org.appfuse.service.impl.GenericManagerImpl">
         <constructor-arg>
             <bean class="org.appfuse.dao.ibatis.GenericDaoiBatis">
                 <constructor-arg value="org.appfuse.model.User"/>
                 <property name="dataSource" ref="dataSource"/>
                 <property name="sqlMapClient" ref="sqlMapClient"/>
             </bean>
         </constructor-arg>
     </bean>
 

Author:

Matt Raible Updated by jgarcia: added full text search + reindexing

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericDao<T,PK>	dao GenericDao instance, set by constructor of child classes
protected org.apache.commons.logging.Log	log Log variable for all child classes.

Constructor Summary

Constructors

Constructor and Description
GenericManagerImpl()
GenericManagerImpl(GenericDao<T,PK> genericDao)

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.
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.
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 based on class and id
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 q, Class clazz) Generic method to search for an object.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Log variable for all child classes. Uses LogFactory.getLog(getClass()) from Commons Logging

dao

protected GenericDao<T,PK extends Serializable> dao

GenericDao instance, set by constructor of child classes

Constructor Detail

GenericManagerImpl

public GenericManagerImpl()

GenericManagerImpl

public GenericManagerImpl(GenericDao<T,PK> genericDao)

Method Detail

getAll

public 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.

Specified by:

getAll in interface GenericManager<T,PK extends Serializable>

Returns:

List of populated objects

get

public 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.

Specified by:

get in interface GenericManager<T,PK extends Serializable>

Parameters:

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

Returns:

a populated object

See Also:

org.springframework.orm.ObjectRetrievalFailureException

exists

public boolean exists(PK id)

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

Specified by:

exists in interface GenericManager<T,PK extends Serializable>

Parameters:

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

Returns:

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

save

public T save(T object)

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

Specified by:

save in interface GenericManager<T,PK extends Serializable>

Parameters:

object - the object to save

Returns:

the updated object

remove

public void remove(T object)

Generic method to delete an object

Specified by:

remove in interface GenericManager<T,PK extends Serializable>

Parameters:

object - the object to remove

remove

public void remove(PK id)

Generic method to delete an object based on class and id

Specified by:

remove in interface GenericManager<T,PK extends Serializable>

Parameters:

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

search

public List<T> search(String q,
             Class clazz)

Generic method to search for an object.

Search implementation using Hibernate Search.

Specified by:

search in interface GenericManager<T,PK extends Serializable>

Parameters:

q - the search term

clazz - type of class to search for.

Returns:

a list of matched objects

reindex

public void reindex()

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

Specified by:

reindex in interface GenericManager<T,PK extends Serializable>

reindexAll

public void reindexAll(boolean async)

Generic method to regenerate full text index of all indexed classes

Specified by:

reindexAll in interface GenericManager<T,PK extends Serializable>

Parameters:

async - true to perform the reindexing asynchronously