com.neurosys.dao.jpa

Interface QueryableDao<T>

Type Parameters:

T -

All Superinterfaces:

FreeQuery, GenericDao<T>

All Known Subinterfaces:

EventsDao<E>, EventsService<E>, GenericObjectDao, LogisticsDao, OrderDao<O>, ProductDao<T>, ProductDao<T>, ProductService<T>

All Known Implementing Classes:

AbstractConfigurationJPADaoImpl, AbstractContentHierarchyDaoImpl, AbstractHierarchyDaoImpl, AbstractQueryableDaoImpl, CommentDaoImpl, ConfigurationJPADaoImpl, ContentDaoImpl, DefaultEventsService, DefaultTransactionService, EcomUserDaoImpl, EventsDaoImpl, GenericObjectDaoImpl, GenericQueryableDaoImpl, LogisticsDaoImpl, OrderDaoImpl, PostDaoImpl, ProductDaoImpl, ProductDaoImpl, ProductServiceImpl, PromotionDaoImpl, RatingDaoImpl, RegisteredUserLoginDaoImpl, UserDaoImpl

public interface QueryableDao<T>
extends GenericDao<T>

Query driven API

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
Long	count(Query<T> query) Execute Query and on Queryable fields only.
T	getEntityInstance() The entity instance maybe an extension of the Base ensure Queries work for extensions derive the exact instance required for the Query.
List<T>	query(Query<T> query) Execute Query and on Queryable fields only.
<SUB_T> List<SUB_T>	query(Query<T> query, Class<SUB_T> claz) Derive a SubSet (claz) of T only as an queried entity.
Page<T>	queryPage(Query<T> query) Execute Query and on Queryable fields only.
<SUB_T> Page<SUB_T>	queryPage(Query<T> query, Class<SUB_T> claz) Derive a SubSet (claz) of T only as an queried entity.

Methods inherited from interface com.neurosys.dao.GenericDao

delete, delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Method Detail

query

@Transactional(readOnly=true)
List<T> query(Query<T> query)
                                     throws Exception

Execute Query and on Queryable fields only.
If a field is to be search on NULL, then explicitly add the Java field name to the nullSet
Also note that beans that do not follow standard java bean naming conventions; on their Queryable fields will face problems.

Parameters:

query - as Queryable

Throws:

Exception

queryPage

@Transactional(readOnly=true)
Page<T> queryPage(Query<T> query)
                                         throws Exception

Execute Query and on Queryable fields only.
If a field is to be search on NULL, then explicitly add the Java field name to the Query.setNullSet(Set)
Also note that beans that do not follow standard java bean naming conventions; on their Queryable fields will face problems.

Parameters:

query - as Queryable

Throws:

Exception

count

@Transactional(readOnly=true)
Long count(Query<T> query)
                                  throws Exception

Execute Query and on Queryable fields only.
If a field is to be search on NULL, then explicitly add the Java field name to the Query.setNullSet(Set)
Also note that beans that do not follow standard java bean naming conventions; on their Queryable fields will face problems.

Parameters:

query - as Queryable

Throws:

Exception

query

<SUB_T> List<SUB_T> query(Query<T> query,
                          Class<SUB_T> claz)
                   throws Exception

Derive a SubSet (claz) of T only as an queried entity. The result entity should have common accessor methods as queried Entity.
The above technically translates to Result Fields = Query.setExcludedFields(T-class)

Parameters:

query - as Query

claz - as Class

Returns:

an object that contains properties that is a Sub Set of T, Note SUB_T does not even have to extend T.

Throws:

Exception

queryPage

<SUB_T> Page<SUB_T> queryPage(Query<T> query,
                              Class<SUB_T> claz)
                       throws Exception

Derive a SubSet (claz) of T only as an queried entity. The result entity should have common accessor methods as queried Entity.
The above technically translates to Result Fields = Query.setExcludedFields(T-class)

Parameters:

query - as Query

claz - as Class

Returns:

an object that contains properties that is a Sub Set of T, Note SUB_T does not even have to extend T.

Throws:

Exception

getEntityInstance

T getEntityInstance()

The entity instance maybe an extension of the Base ensure Queries work for extensions derive the exact instance required for the Query.

Returns: