Package ch.tocco.nice2.persist.core.api.util

Interface QueryPopulator

All Known Implementing Classes:

QueryPopulatorImpl

public interface QueryPopulator

Attempts to ease adding parameters to a query that are often used and/or evaluated as late as possible (for example the current date).

This service will search the query string for named parameters. If it finds one that it knows the value for, it will set it in the query.

Example:

   String qs = "find Date where relUser.pk == :currentUser";
   DynamicQueryPopulator dargs = //inject via spring
   Query q = dargs.createAndPopulateQuery(qs, ctx);
   EntityList list = q.execut();
 

Please see the implementation class for how to configure this service. To know all known parameter names search the hivemodule.xml files for 'ArgumentFactory'.

Method Summary

Modifier and Type	Method	Description
Query	createAndPopulateQuery(String queryStr, Context context)	Calls populateQuery(Query, String, Context) after compiling the query string into a Query object.
Set<String>	getRegisteredParameterNames()	Returns all parameter names that are known to this service.
void	populateQuery(Query q, FuncallNode qstr, Context context)
void	populateQuery(Query q, String qstr, Context context)	Populates the given query according to the parameter names it recognizes.

Method Details

populateQuery

void populateQuery(Query q,
 String qstr,
 Context context)
            throws PersistException

Populates the given query according to the parameter names it recognizes.

It searches the query string for any occurence of a registered named parameter and invokes Query.setParameter(String, Object) with the appropriate value.

Parameters:

q - the compiled query

qstr - the string used to compile the query

context - the persist context to use

Throws:

PersistException

populateQuery

void populateQuery(Query q,
 FuncallNode qstr,
 Context context)
            throws PersistException

Throws:

PersistException

createAndPopulateQuery

Query createAndPopulateQuery(String queryStr,
 Context context)
                      throws PersistException

Calls populateQuery(Query, String, Context) after compiling the query string into a Query object.

Parameters:

queryStr - the query string

context - the persist context to use

Returns:

the compiled and populated query

Throws:

PersistException

getRegisteredParameterNames

Set<String> getRegisteredParameterNames()

Returns all parameter names that are known to this service.