JPAQueryTransformer (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.dao.jpa.EntityManagerLookupAware
- - com.neurosys.dao.jpa.JPAQueryTransformer

All Implemented Interfaces:

QueryTransformer, UpdatableContext<javax.persistence.EntityManager>, Serializable, org.apache.commons.collections.Transformer

Direct Known Subclasses:

TenantContextJPAQueryTransformer
```
public class JPAQueryTransformer
extends EntityManagerLookupAware
implements QueryTransformer, Serializable
```
Fire any JPA Query and return the the fields as an Object[]; so the transformer itself will return List<Object[]>
Any params supplied will be applied sequentially in the input is an Object[] or a List. If The query uses parameters then it should put the params ?1, ?2 etc
One can provide PageInfo as the input itself or last param in the parameter Array; if pagination is required.
One can also provide a Map to this Transformer. When a Map is passed then the Query params should be :paramNameAsKeyInMap and any value thats associated as a PageInfo will be used to set the PageInfo to the Query.

If the input is not an Array, List, Map or PageInfo and a fieldMapping is provided then it can take parameter names defined and map it to the fields in the mapping.

If the query has no parameter required then the input will be ignored if no other condition was satisfied while evaluation. This is evaluated last. TODO: Add Unit Test case for case with Pagination (say 574, page-size=500 records etc) Example of a JPA query with params:
```
 
<bean class="com.neurosys.dao.jpa.JPAQueryTransformer">
		<property name="query"><value><![CDATA[
SELECT orders from Order orders WHERE purchaseDate BETWEEN ?1 AND ?2 ORDER BY id
		]]></value></property>
  <property name="queryIsNative" value="false" />				
</bean>
 
```
Example of a JPA query with List or Array as a single param:
```
 
<bean class="com.neurosys.dao.jpa.JPAQueryTransformer">
  	<property name="query" value="SELECT cf FROM ContentFacet cf WHERE id in (?1)" />
    <property name="paramAsSingleInput" value="true" />
</bean>
 
```
Example of a JPA NATIVE query:
```
 
<bean id="deleteImageAssociation" class="com.neurosys.dao.jpa.JPAExecuteTransformer">
		<property name="query"><value><![CDATA[
DELETE pa FROM product_attributes pa RIGHT OUTER JOIN product p ON pa.product_id=p.id WHERE pa.name in ('mainImgSrc','zoomImgSrc') AND p.productCode is NOT NULL
		]]></value></property>
		<property name="queryIsNative" value="true" />	  		
</bean>	
 
```
To convert native query result into entities can look @ QueryResultArrayToEntityTransformer and ObjectArrayToEntityTransformer.
To convert JSON query to Query, can use QueryReader.
Author:

Arjun Dhar

See Also:

optimize(), overrideFinalQuery(String, Query), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`expectSingleResult` If true it will attempt to return only 1 Object or null if no match to query
`protected Map<String,?>`	`fieldMapping` Map from query param name to field name or Transformer that will act on input to get param value.
`protected String`	`query`
`protected boolean`	`queryIsNative` If the Query is to be fired in JPA or native DB SQL language
`protected QueryOptimizer`	`queryOptimizer` An optional configurable `QueryOptimizer`
`protected String`	`queryOptimizerEntityAlias` Since the query will not change, within the Query what is the Alias of the entity/table

Constructor Summary

Constructors
Constructor and Description

JPAQueryTransformer()

JPAQueryTransformer(String query)

Constructors
Constructor and Description
`JPAQueryTransformer()`
`JPAQueryTransformer(String query)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`derivedQuery()` Opportunity to override core `query` string.
`Map<String,?>`	`getFieldMapping()` Map from query param name to field name or Transformer that will act on input to get param value.
`PageInfo`	`getPageInfo()` Optional.
`String`	`getQuery()` Query to process.
`QueryOptimizer`	`getQueryOptimizer()` `QueryOptimizer` to `optimize()` the set `query` If `isQueryIsNative()` is true then the Optimizer should ensure it can work on native queries else on entities.
`String`	`getQueryOptimizerEntityAlias()` Since the query will not change, within the Query what is the Alias of the entity/table
`boolean`	`isExpectSingleResult()` If true it will attempt to return only 1 Object or null if no match to query
`boolean`	`isParamAsSingleInput()` If the input is a List of Collection and we wish to process it as a single parameter make this true OR wrap it in an Object Array.
`boolean`	`isQueryIsNative()` If the Query is to be fired in JPA or native DB SQL language
`protected void`	`optimize()` If `queryOptimizer` is set then optimize the #query.
`protected void`	`overrideFinalQuery(String queryString, javax.persistence.Query q)` Opportunity to override any thing in the final generated Query `Query` in the `transform(Object)` process.
`void`	`setExpectSingleResult(boolean expectSingleResult)` If true it will attempt to return only 1 Object or null if no match to query
`void`	`setFieldMapping(Map<String,?> fieldMapping)` Map from query param name to field name or Transformer that will act on input to get param value.
`void`	`setPageInfo(PageInfo pageInfo)` Optional.
`void`	`setParamAsSingleInput(boolean paramAsSingleInput)` If the input is a List of Collection and we wish to process it as a single parameter make this true OR wrap it in an Object Array.
`void`	`setQuery(String query)` Query to process.
`void`	`setQueryIsNative(boolean queryIsNative)` If the Query is to be fired in JPA or native DB SQL language
`void`	`setQueryOptimizer(QueryOptimizer queryOptimizer)` `QueryOptimizer` to `optimize()` the set `query` If `isQueryIsNative()` is true then the Optimizer should ensure it can work on native queries else on entities.
`void`	`setQueryOptimizerEntityAlias(String queryOptimizerEntityAlias)` Since the query will not change, within the Query what is the Alias of the entity/table
`Object`	`transform(Object input)`

Methods inherited from class com.neurosys.dao.jpa.EntityManagerLookupAware
getEntityManager, getEntityManagerProvider, setEntityManager, setEntityManagerProvider, updateContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - query
```
protected String query
```
  - queryIsNative
```
protected boolean queryIsNative
```
    If the Query is to be fired in JPA or native DB SQL language
    
    Default value:
    
    false
  - expectSingleResult
```
protected boolean expectSingleResult
```
    If true it will attempt to return only 1 Object or null if no match to query
    
    Default value:
    
    false
  - fieldMapping
```
protected Map<String,?> fieldMapping
```
    Map from query param name to field name or Transformer that will act on input to get param value. Used incase parameters are names and the input is not an Object[]
  - queryOptimizer
```
protected QueryOptimizer queryOptimizer
```
    An optional configurable QueryOptimizer
  - queryOptimizerEntityAlias
```
protected String queryOptimizerEntityAlias
```
    Since the query will not change, within the Query what is the Alias of the entity/table
- Constructor Detail
  - JPAQueryTransformer
```
public JPAQueryTransformer()
```
  - JPAQueryTransformer
```
public JPAQueryTransformer(String query)
```
- Method Detail
  - optimize
```
@PostConstruct
protected void optimize()
```
    If queryOptimizer is set then optimize the #query.
    In a context that supports PostConstruct, this is automatically done, in an API call one has to explicitly call this.
  - transform
```
@Transactional(readOnly=true)
public Object transform(Object input)
```
    Specified by:
    
    transform in interface org.apache.commons.collections.Transformer
  - overrideFinalQuery
```
protected void overrideFinalQuery(String queryString,
                                  javax.persistence.Query q)
```
    Opportunity to override any thing in the final generated Query Query in the transform(Object) process.
    
    Parameters:
    
    queryString - as String (immutable, provided for reference purpose only)
    
    q - as Query
    
    See Also:
    
    to manipulate original query string dynamically.
  - derivedQuery
```
public String derivedQuery()
```
    Opportunity to override core query string.
    
    Returns:
    
    String
    
    See Also:
    
    overrideFinalQuery(String, Query)
  - getQuery
```
public String getQuery()
```
    Description copied from interface: QueryTransformer
    
    Query to process.
    
    Specified by:
    
    getQuery in interface QueryTransformer
    
    Returns:
    
    query
  - setQuery
```
public void setQuery(String query)
```
    Description copied from interface: QueryTransformer
    
    Query to process.
    
    Specified by:
    
    setQuery in interface QueryTransformer
  - isQueryIsNative
```
public boolean isQueryIsNative()
```
    If the Query is to be fired in JPA or native DB SQL language
  - setQueryIsNative
```
public void setQueryIsNative(boolean queryIsNative)
```
    If the Query is to be fired in JPA or native DB SQL language
    
    Default value:
    
    false
  - isExpectSingleResult
```
public boolean isExpectSingleResult()
```
    If true it will attempt to return only 1 Object or null if no match to query
    
    Specified by:
    
    isExpectSingleResult in interface QueryTransformer
    
    Returns:
    
    Default value:
    
    false
  - setExpectSingleResult
```
public void setExpectSingleResult(boolean expectSingleResult)
```
    If true it will attempt to return only 1 Object or null if no match to query
    
    Specified by:
    
    setExpectSingleResult in interface QueryTransformer
    
    Default value:
    
    false
  - getFieldMapping
```
public Map<String,?> getFieldMapping()
```
    Map from query param name to field name or Transformer that will act on input to get param value. Used incase parameters are names and the input is not an Object[]
    
    Specified by:
    
    getFieldMapping in interface QueryTransformer
    
    Returns:
  - setFieldMapping
```
public void setFieldMapping(Map<String,?> fieldMapping)
```
    Map from query param name to field name or Transformer that will act on input to get param value. Used incase parameters are names and the input is not an Object[]
    
    Specified by:
    
    setFieldMapping in interface QueryTransformer
  - getQueryOptimizer
```
public QueryOptimizer getQueryOptimizer()
```
    QueryOptimizer to optimize() the set query
    
    If isQueryIsNative() is true then the Optimizer should ensure it can work on native queries else on entities.
  - setQueryOptimizer
```
public void setQueryOptimizer(QueryOptimizer queryOptimizer)
```
    QueryOptimizer to optimize() the set query
    
    If isQueryIsNative() is true then the Optimizer should ensure it can work on native queries else on entities.
  - getQueryOptimizerEntityAlias
```
public String getQueryOptimizerEntityAlias()
```
    Since the query will not change, within the Query what is the Alias of the entity/table
  - setQueryOptimizerEntityAlias
```
public void setQueryOptimizerEntityAlias(String queryOptimizerEntityAlias)
```
    Since the query will not change, within the Query what is the Alias of the entity/table
  - isParamAsSingleInput
```
public boolean isParamAsSingleInput()
```
    If the input is a List of Collection and we wish to process it as a single parameter make this true OR wrap it in an Object Array. This is a more convenient way.
    
    Specified by:
    
    isParamAsSingleInput in interface QueryTransformer
    
    Returns:
  - setParamAsSingleInput
```
public void setParamAsSingleInput(boolean paramAsSingleInput)
```
    If the input is a List of Collection and we wish to process it as a single parameter make this true OR wrap it in an Object Array. This is a more convenient way.
    
    Specified by:
    
    setParamAsSingleInput in interface QueryTransformer
  - getPageInfo
```
public PageInfo getPageInfo()
```
    Optional. If supplied will override any dynamic PageInfo details passed
  - setPageInfo
```
public void setPageInfo(PageInfo pageInfo)
```
    Optional. If supplied will override any dynamic PageInfo details passed

Class JPAQueryTransformer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.dao.jpa.EntityManagerLookupAware

Methods inherited from class java.lang.Object

Field Detail

query

queryIsNative

expectSingleResult

fieldMapping

queryOptimizer

queryOptimizerEntityAlias

Constructor Detail

JPAQueryTransformer

JPAQueryTransformer

Method Detail

optimize

transform

overrideFinalQuery

derivedQuery

getQuery

setQuery

isQueryIsNative

setQueryIsNative

isExpectSingleResult

setExpectSingleResult

getFieldMapping

setFieldMapping

getQueryOptimizer

setQueryOptimizer

getQueryOptimizerEntityAlias

setQueryOptimizerEntityAlias

isParamAsSingleInput

setParamAsSingleInput

getPageInfo

setPageInfo