org.rhq.enterprise.server.util

Class CriteriaQueryGenerator

java.lang.Object

org.rhq.enterprise.server.util.CriteriaQueryGenerator

public final class CriteriaQueryGenerator
extends Object

A query generator used to generate queries with specific filtering, prefetching, or sorting requirements.

Author:

Joseph Marques

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CriteriaQueryGenerator.AuthorizationTokenType

Constructor Summary

Constructors

Constructor and Description
CriteriaQueryGenerator(org.rhq.core.domain.criteria.Criteria criteria)
CriteriaQueryGenerator(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.Criteria criteria)

Method Summary

Methods

Modifier and Type	Method and Description
void	alterCountProjection(String countProjection) Sometimes the altered projection (alterProjection(String)) might cause the result set to have different number of results than the default/unaltered projection.
void	alterProjection(String projection) If you want to return something other than the list of entities represented by the passed Criteria object, you can alter the projection here to return a customized subset or superset of data.
static String	getCleansedFieldName(Field field, int leadingCharsToStrip)
javax.persistence.Query	getCountQuery(javax.persistence.EntityManager em)
List<String>	getFetchFields(org.rhq.core.domain.criteria.Criteria criteria)
Map<String,Object>	getFilterFields(org.rhq.core.domain.criteria.Criteria criteria)
List<Field>	getJoinFetchFields() Note: This method should only be called after getQueryString(boolean)} because it is that method where the persistentBagFields property is initialized.
static org.rhq.core.domain.util.PageControl	getPageControl(org.rhq.core.domain.criteria.Criteria criteria)
String	getParameterReplacedQuery(boolean countQuery)
List<Field>	getPersistentBagFields() Note: This method should only be called after getQueryString(boolean)} because it is that method where the persistentBagFields property is initialized.
javax.persistence.Query	getQuery(javax.persistence.EntityManager em)
String	getQueryString(boolean countQuery)
boolean	isProjectionAltered()
static void	main(String[] args)
void	setAuthorizationBundleFragment(CriteriaQueryGenerator.AuthorizationTokenType type, int subjectId)
void	setAuthorizationBundleFragment(CriteriaQueryGenerator.AuthorizationTokenType type, int subjectId, String fragment)
void	setAuthorizationCustomConditionFragment(String fragment)
void	setAuthorizationResourceFragment(CriteriaQueryGenerator.AuthorizationTokenType type, int subjectId)
void	setAuthorizationResourceFragment(CriteriaQueryGenerator.AuthorizationTokenType type, String fragment, int subjectId)
void	setGroupByClause(String groupByClause) The groupBy clause can be set if and only if the projection is altered.
void	setHavingClause(String havingClause) The having clause can be set if and only if the groupBy clause is set.
static void	testAlertCriteria()
static void	testInheritanceCriteria()
static void	testResourceCriteria()
static void	testResourceGroupCriteria()
static void	testSubjectCriteria()

Methods inherited from class java.lang.Object

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

Constructor Detail

CriteriaQueryGenerator

public CriteriaQueryGenerator(org.rhq.core.domain.criteria.Criteria criteria)

CriteriaQueryGenerator

public CriteriaQueryGenerator(org.rhq.core.domain.auth.Subject subject,
                      org.rhq.core.domain.criteria.Criteria criteria)

Method Detail

setAuthorizationCustomConditionFragment

public void setAuthorizationCustomConditionFragment(String fragment)

setAuthorizationResourceFragment

public void setAuthorizationResourceFragment(CriteriaQueryGenerator.AuthorizationTokenType type,
                                    int subjectId)

setAuthorizationResourceFragment

public void setAuthorizationResourceFragment(CriteriaQueryGenerator.AuthorizationTokenType type,
                                    String fragment,
                                    int subjectId)

setAuthorizationBundleFragment

public void setAuthorizationBundleFragment(CriteriaQueryGenerator.AuthorizationTokenType type,
                                  int subjectId)

setAuthorizationBundleFragment

public void setAuthorizationBundleFragment(CriteriaQueryGenerator.AuthorizationTokenType type,
                                  int subjectId,
                                  String fragment)

getParameterReplacedQuery

public String getParameterReplacedQuery(boolean countQuery)

getQueryString

public String getQueryString(boolean countQuery)

getFetchFields

public List<String> getFetchFields(org.rhq.core.domain.criteria.Criteria criteria)

getCleansedFieldName

public static String getCleansedFieldName(Field field,
                          int leadingCharsToStrip)

getFilterFields

public Map<String,Object> getFilterFields(org.rhq.core.domain.criteria.Criteria criteria)

getPersistentBagFields

public List<Field> getPersistentBagFields()

Note: This method should only be called after getQueryString(boolean)} because it is that method where the persistentBagFields property is initialized.

Returns:

Returns a list of fields from the persistent class to which the criteria class corresponds. The fields in the list are themselves instances of List and have "bag" semantics.

getJoinFetchFields

public List<Field> getJoinFetchFields()

Note: This method should only be called after getQueryString(boolean)} because it is that method where the persistentBagFields property is initialized.

The elements of the returned list are a (sub)set of the fields that the criteria object specified to be fetched (using the fetchXXX() methods). If the CriteriaQueryRunner is not set to automatically fetch all the fields, you need to manually initialize these fields by for example using CriteriaQueryRunner.initFetchFields(Object) method on each of the results.

Returns:

Returns a list of fields from the persistent class to which the criteria class corresponds. The fields in the list are fields specified by the criteria to be fetched (using the fetchXXX() methods).

See Also:

alterProjection(String) for special attention you need to make when mixing fetching fields and altered projection.

alterProjection

public void alterProjection(String projection)

If you want to return something other than the list of entities represented by the passed Criteria object, you can alter the projection here to return a customized subset or superset of data. The projection will only affect the ResultSet for the data query, not the count query.

If you are projecting a composite object that does not directly extend the entity your Criteria object represents, then you will need to manually initialize the persistent bags and fetch fields using the CriteriaQueryRunner.initFetchFields(Object) method for each object in the results (for which you need to instantiate the CriteriaQueryRunner with automatic fetching switched OFF). Note that this will NOT work on the composite object itself. You need to pass an instance of the entity class to the CriteriaQueryRunner.initFetchFields(Object) method.

alterCountProjection

public void alterCountProjection(String countProjection)

Sometimes the altered projection (alterProjection(String)) might cause the result set to have different number of results than the default/unaltered projection. Leaving the count query in the default form could then generate seemingly inconsistent results, where the data query and the count query wouldn't match up.

An example of a projection that might alter the number of results is the " distinct ..." projection that would only return distinct results from a dataset, while the default count query (COUNT(*)) would produce the count including duplicate results that were eliminated in the returned data.

In these cases one can also alter the count query to count the results the data query will return.

Parameters:

countProjection - a complete JPQL fragment expressing the count expression (e.g. COUNT(DISTINCT ...))

isProjectionAltered

public boolean isProjectionAltered()

setGroupByClause

public void setGroupByClause(String groupByClause)

The groupBy clause can be set if and only if the projection is altered. The passed argument should not be prefixed with 'group by'; that part of the query will be auto-generated if the argument is non-null. The new projection must follow standard rules as they apply to statements with groupBy clauses.

setHavingClause

public void setHavingClause(String havingClause)

The having clause can be set if and only if the groupBy clause is set. The passed argument should not be prefixed with 'having'; that part of the query will be auto-generated if the argument is non-null. The having clause must follow standard rules as they apply to statements with groupBy clauses.

getQuery

public javax.persistence.Query getQuery(javax.persistence.EntityManager em)

getCountQuery

public javax.persistence.Query getCountQuery(javax.persistence.EntityManager em)

main

public static void main(String[] args)

testSubjectCriteria

public static void testSubjectCriteria()

testAlertCriteria

public static void testAlertCriteria()

testInheritanceCriteria

public static void testInheritanceCriteria()

testResourceGroupCriteria

public static void testResourceGroupCriteria()

testResourceCriteria

public static void testResourceCriteria()

getPageControl

public static org.rhq.core.domain.util.PageControl getPageControl(org.rhq.core.domain.criteria.Criteria criteria)