The pattern saves us a lot of tedious binding code.
However, one still need to implement the same method for each Entity.
To save us the redundant work of defining the same QBE method for each entity, where only the entity is changed, we could utilize Generics.
Using Generics we will implement only one method in a base class, and each concrete QBE (on certain @Entity) will inherit from that base class.
Lets see that in action.
First, we define the interface for the base class:
public interface BaseDAO{ /** * Perform a query based on the values in the given object. * Each (String) attribute will be searched based on the Like comparison. * Comply the QueryByExample (QBE) pattern * @param modelEntity The Entity with values to search * @param propertiesToExclude Any property which the search will ignored. * @return Instances that answer the given parameters values (empty if none) */ public List getByElementsLike(T modelEntity, List propertiesToExclude); /** * Perform a query based on the values in the given object. * Each attribute will be searched based on the Equality comparison. * Comply the QueryByExample (QBE) pattern * @param modelEntity The Entity with values to search * @param propertiesToExclude Any property which the search will ignored * @return Instances that answer the given parameters values (empty if none) */ public List getByElementsEqual(T modelEntity, List propertiesToExclude); }
Second step is to write the Base class implementation
public class BaseDaoImplimplements BaseDAO { //Get DB session access using Spring 3.1 Entity Manger @PersistenceContext protected EntityManager em; protected Class entityClass; //Initialize the entity class @SuppressWarnings("unchecked") public BaseRepositoryImpl() { ParameterizedType genericSuperclass = (ParameterizedType) getClass().getGenericSuperclass(); this.entityClass = (Class ) genericSuperclass.getActualTypeArguments()[0]; } protected Class getEntityClass() { return entityClass; } public List getByElementsLike(T modelEntity,List propertiesToExclude) { // get the native hibernate session Session session = (Session) em.getDelegate(); // create an example from our model-entity, exclude all zero valued numeric properties Example example = Example.create(modelEntity).excludeZeroes().enableLike(MatchMode.ANYWHERE); for (String property : propertiesToExclude) { example.excludeProperty(property); } // create criteria based on the customer example Criteria criteria = session.createCriteria(getEntityClass()).add(example); // perform the query return criteria.list(); } public List getByElementsEqual(T modelEntity,List propertiesToExclude) { // get the native hibernate session Session session = (Session) em.getDelegate(); // create an example from our customer, exclude all zero valued numeric properties Example example = Example.create(modelEntity).excludeZeroes(); for (String property : propertiesToExclude) { example.excludeProperty(property); } // create criteria based on the customer example Criteria criteria = session.createCriteria(getEntityClass()).add(example); // perform the query return criteria.list(); } }
Third step is to extend the base class:
@Entity public class Order{ .. } @Entity public class Item{ .. } public class OrderDaoImpl extends BaseDaoImplimplements BaseDao { //No need to implement the QBE again here } public class ItemDaoImpl extends BaseDaoImpl - implements BaseDao
- { //No need to implement the QBE again here }
Kindly let me know for any further improvements.
"getByElemetnsLike" and "getByElemetnsEqual" appear to have a typo. You probably meant to write "getByElementsLike" and "getByElementsEqual".
ReplyDeleteThanks! Will fix it..
Delete