com.impetus.kundera.query

Class QueryImpl<E>

java.lang.Object

com.impetus.kundera.query.QueryImpl<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Query

Direct Known Subclasses:

LuceneQuery

public abstract class QueryImpl<E>
extends Object
implements javax.persistence.Query, Query

The Class QueryImpl.

Author:

vivek.mishra

Field Summary

Fields

Modifier and Type	Field and Description
private Integer	fetchSize The fetch size.
protected int	firstResult The first result.
private Map<String,Object>	hints The hints.
protected boolean	isSingleResult The is single result.
protected EntityManagerFactoryImpl.KunderaMetadata	kunderaMetadata The kundera metadata.
protected KunderaQuery	kunderaQuery The kundera query.
private static org.slf4j.Logger	log The log.
protected int	maxResult Default maximum result to fetch.
private Set<javax.persistence.Parameter<?>>	parameters The parameters.
protected PersistenceDelegator	persistenceDelegeator The persistence delegeator.
protected Integer	ttl The ttl.

Constructor Summary

Constructors

Constructor and Description
QueryImpl(KunderaQuery kunderaQuery, PersistenceDelegator persistenceDelegator, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Instantiates a new query impl.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToRelationStack(Map<Object,Object> relationStack, Object entity, EntityMetadata m) Adds the to relation stack.
void	applyTTL(int ttlInSeconds) add support to enable TTL for UPDATE/INSERT/DELETE queries.
private void	assignReferenceToProxy(List results) If returned collection of object holds a reference to.
abstract void	close() Reinstate .
int	executeUpdate()
protected List	fetch() Returns collection of fetched entities.
protected abstract List	findUsingLucene(EntityMetadata m, Client client) Find using lucene.
private List<Object>	findUsingLucene(EntityMetadata m, Client client, Object[] primaryKeys) find data using lucene.
protected String[]	getColumns(String[] columns, EntityMetadata m) Gets the columns.
private Object	getEntityFieldValue(EntityMetadata entityMetadata, Object entity, String field) Gets the entity field value.
protected EntityMetadata	getEntityMetadata() Returns entity metadata, in case of native query mapped class is present within application metadata.
Integer	getFetchSize()
int	getFirstResult()
javax.persistence.FlushModeType	getFlushMode()
Map<String,Object>	getHints() Returns a Map containing query hints set by user.
String	getJPAQuery() Gets the jPA query.
KunderaQuery	getKunderaQuery() Gets the kundera query.
javax.persistence.LockModeType	getLockMode()
int	getMaxResults()
javax.persistence.Parameter<?>	getParameter(int paramInt)
<T> javax.persistence.Parameter<T>	getParameter(int paramInt, Class<T> paramClass)
javax.persistence.Parameter<?>	getParameter(String paramString)
<T> javax.persistence.Parameter<T>	getParameter(String paramString, Class<T> paramClass)
private javax.persistence.Parameter	getParameterByName(String name) Returns specific parameter instance for given name.
private javax.persistence.Parameter	getParameterByOrdinal(Integer position) Returns parameter by ordinal.
Set<javax.persistence.Parameter<?>>	getParameters()
Object	getParameterValue(int paramInt)
<T> T	getParameterValue(javax.persistence.Parameter<T> paramParameter)
Object	getParameterValue(String paramString)
protected abstract EntityReader	getReader() Method returns entity reader.
List<?>	getResultList()
Object	getSingleResult() *********************** Methods from Query interface ******************************.
protected void	handlePostEvent() Handle post event callbacks.
boolean	isBound(javax.persistence.Parameter<?> paramParameter)
private boolean	isRelational(EntityMetadata m) Returns true, if associated entity holds relational references(e.g.
abstract <E> Iterator<E>	iterate() Iterates over result.
protected void	onDeleteOrUpdate(List results) Performs delete or update based on query.
protected abstract int	onExecuteUpdate() Method to be invoked on query.executeUpdate().
private void	onNativeCondition() Method to handle get/set Parameter supplied for native query.
private List<Object>	onParameterValue(String paramString) Returns parameter value.
protected Object	onReturnResults(List results) On return results.
private <T> javax.persistence.Parameter<T>	onTypeCheck(Class<T> paramClass, javax.persistence.Parameter<T> parameter) Validated parameter's class with input paramClass.
protected int	onUpdateDeleteEvent() On update delete event.
protected void	onValidateSingleResult(List results) On validate single result.
private List<Object>	populateEmbeddedIdUsingLucene(EntityMetadata m, Client client, List<Object> result, Map<String,Object> searchFilter, MetamodelImpl metaModel) Populate using lucene for embeddeId.
protected abstract List<Object>	populateEntities(EntityMetadata m, Client client) Populate entities, Method to populate data in case no relation exist!.
private void	populateGroupByResponse(Map<String,Object> aggregations, Iterable<org.eclipse.persistence.jpa.jpql.parser.Expression> resultOrderIterable, List<Object> results, Client client, EntityMetadata m) Populate group by response.
private List	populateUsingElasticSearch(Client client, EntityMetadata m) Populate using elastic search.
protected List<Object>	populateUsingLucene(EntityMetadata m, Client client, List<Object> result, String[] columnsToSelect) Populate using lucene.
private Object	prepareCompositeIdObject(javax.persistence.metamodel.SingularAttribute attribute, Object compositeId, Map<String,String> uniquePKs, MetamodelImpl metaModel) Prepare composite id object.
protected abstract List<Object>	recursivelyPopulateEntities(EntityMetadata m, Client client) Recursively populate entities.
void	setFetchSize(Integer fetchsize) To set fetch size for query.
javax.persistence.Query	setFirstResult(int startPosition)
javax.persistence.Query	setFlushMode(javax.persistence.FlushModeType flushMode)
javax.persistence.Query	setHint(String hintName, Object value) Sets hint name and value into hints map and returns instance of Query.
javax.persistence.Query	setLockMode(javax.persistence.LockModeType paramLockModeType)
javax.persistence.Query	setMaxResults(int maxResult)
javax.persistence.Query	setParameter(int position, Calendar value, javax.persistence.TemporalType temporalType)
javax.persistence.Query	setParameter(int position, Date value, javax.persistence.TemporalType temporalType)
javax.persistence.Query	setParameter(int position, Object value)
javax.persistence.Query	setParameter(javax.persistence.Parameter<Calendar> paramParameter, Calendar paramCalendar, javax.persistence.TemporalType paramTemporalType)
javax.persistence.Query	setParameter(javax.persistence.Parameter<Date> paramParameter, Date paramDate, javax.persistence.TemporalType paramTemporalType)
<T> javax.persistence.Query	setParameter(javax.persistence.Parameter<T> paramParameter, T paramT)
javax.persistence.Query	setParameter(String name, Calendar value, javax.persistence.TemporalType temporalType)
javax.persistence.Query	setParameter(String name, Date value, javax.persistence.TemporalType temporalType)
javax.persistence.Query	setParameter(String name, Object value)
protected List<Object>	setRelationEntities(List enhanceEntities, Client client, EntityMetadata m) Sets the relation entities.
<T> T	unwrap(Class<T> paramClass)

Methods inherited from class java.lang.Object

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

Field Detail

kunderaQuery

protected KunderaQuery kunderaQuery

The kundera query.

persistenceDelegeator

protected PersistenceDelegator persistenceDelegeator

The persistence delegeator.

kunderaMetadata

protected EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata

The kundera metadata.

log

private static org.slf4j.Logger log

The log.

parameters

private Set<javax.persistence.Parameter<?>> parameters

The parameters.

hints

private Map<String,Object> hints

The hints.

maxResult

protected int maxResult

Default maximum result to fetch.

firstResult

protected int firstResult

The first result.

fetchSize

private Integer fetchSize

The fetch size.

isSingleResult

protected boolean isSingleResult

The is single result.

ttl

protected Integer ttl

The ttl.

Constructor Detail

QueryImpl

public QueryImpl(KunderaQuery kunderaQuery,
         PersistenceDelegator persistenceDelegator,
         EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Instantiates a new query impl.

Parameters:

kunderaQuery - the kundera query

persistenceDelegator - the persistence delegator

kunderaMetadata - the kundera metadata

Method Detail

getJPAQuery

public String getJPAQuery()

Gets the jPA query.

Returns:

the jPA query

getKunderaQuery

public KunderaQuery getKunderaQuery()

Gets the kundera query.

Returns:

the kunderaQuery

executeUpdate

public int executeUpdate()

getResultList

public List<?> getResultList()

setRelationEntities

protected List<Object> setRelationEntities(List enhanceEntities,
                               Client client,
                               EntityMetadata m)

Sets the relation entities.

Parameters:

enhanceEntities - the enhance entities

client - the client

m - the m

Returns:

the list

addToRelationStack

protected void addToRelationStack(Map<Object,Object> relationStack,
                      Object entity,
                      EntityMetadata m)

Adds the to relation stack.

Parameters:

relationStack - the relation stack

entity - the entity

m - the m

populateEmbeddedIdUsingLucene

private List<Object> populateEmbeddedIdUsingLucene(EntityMetadata m,
                                         Client client,
                                         List<Object> result,
                                         Map<String,Object> searchFilter,
                                         MetamodelImpl metaModel)

Populate using lucene for embeddeId.

Parameters:

m - the m

client - the client

result - the result

searchFilter - the search filter

metaModel - the meta model

Returns:

the list

prepareCompositeIdObject

private Object prepareCompositeIdObject(javax.persistence.metamodel.SingularAttribute attribute,
                              Object compositeId,
                              Map<String,String> uniquePKs,
                              MetamodelImpl metaModel)

Prepare composite id object.

Parameters:

attribute - the attribute

compositeId - the composite id

uniquePKs - the unique p ks

metaModel - the meta model

Returns:

the object

findUsingLucene

private List<Object> findUsingLucene(EntityMetadata m,
                           Client client,
                           Object[] primaryKeys)

find data using lucene.

Parameters:

m - the m

client - the client

primaryKeys - the primary keys

Returns:

the list

populateUsingLucene

protected List<Object> populateUsingLucene(EntityMetadata m,
                               Client client,
                               List<Object> result,
                               String[] columnsToSelect)

Populate using lucene.

Parameters:

m - the m

client - the client

result - the result

columnsToSelect - List of column names to be selected (rest should be ignored)

Returns:

the list

populateUsingElasticSearch

private List populateUsingElasticSearch(Client client,
                              EntityMetadata m)

Populate using elastic search.

Parameters:

client - the client

EntityMetadata - the m

Returns:

Result list by fetching from ES

populateGroupByResponse

private void populateGroupByResponse(Map<String,Object> aggregations,
                           Iterable<org.eclipse.persistence.jpa.jpql.parser.Expression> resultOrderIterable,
                           List<Object> results,
                           Client client,
                           EntityMetadata m)

Populate group by response.

Parameters:

aggregations - the aggregations

resultOrderIterable - the result order iterable

results - the results

client - the client

m - the m

getEntityFieldValue

private Object getEntityFieldValue(EntityMetadata entityMetadata,
                         Object entity,
                         String field)

Gets the entity field value.

Parameters:

entityMetadata - the entity metadata

entity - the entity

field - the field

Returns:

the entity field value

populateEntities

protected abstract List<Object> populateEntities(EntityMetadata m,
                            Client client)

Populate entities, Method to populate data in case no relation exist!.

Parameters:

m - the m

client - the client

Returns:

the list

findUsingLucene

protected abstract List findUsingLucene(EntityMetadata m,
                   Client client)

Find using lucene.

Parameters:

m - the m

client - the client

Returns:

the list

recursivelyPopulateEntities

protected abstract List<Object> recursivelyPopulateEntities(EntityMetadata m,
                                       Client client)

Recursively populate entities.

Parameters:

m - the m

client - the client

Returns:

the list

getReader

protected abstract EntityReader getReader()

Method returns entity reader.

Returns:

entityReader entity reader.

onExecuteUpdate

protected abstract int onExecuteUpdate()

Method to be invoked on query.executeUpdate().

Returns:

the int

getEntityMetadata

protected EntityMetadata getEntityMetadata()

Returns entity metadata, in case of native query mapped class is present within application metadata.

Returns:

entityMetadata entity metadata.

onUpdateDeleteEvent

protected int onUpdateDeleteEvent()

On update delete event.

Returns:

the int

onDeleteOrUpdate

protected void onDeleteOrUpdate(List results)

Performs delete or update based on query.

Parameters:

results - list of objects to be merged/deleted.

getSingleResult

public Object getSingleResult()

*********************** Methods from Query interface ******************************.

Returns:

the single result

setFirstResult

public javax.persistence.Query setFirstResult(int startPosition)

setFlushMode

public javax.persistence.Query setFlushMode(javax.persistence.FlushModeType flushMode)

setHint

public javax.persistence.Query setHint(String hintName,
                              Object value)

Sets hint name and value into hints map and returns instance of Query.

Parameters:

hintName - the hint name

value - the value

Returns:

the query

setMaxResults

public javax.persistence.Query setMaxResults(int maxResult)

setParameter

public javax.persistence.Query setParameter(String name,
                                   Object value)

setParameter

public javax.persistence.Query setParameter(int position,
                                   Object value)

setParameter

public javax.persistence.Query setParameter(String name,
                                   Date value,
                                   javax.persistence.TemporalType temporalType)

setParameter

public javax.persistence.Query setParameter(String name,
                                   Calendar value,
                                   javax.persistence.TemporalType temporalType)

setParameter

public javax.persistence.Query setParameter(int position,
                                   Date value,
                                   javax.persistence.TemporalType temporalType)

setParameter

public javax.persistence.Query setParameter(int position,
                                   Calendar value,
                                   javax.persistence.TemporalType temporalType)

getMaxResults

public int getMaxResults()

getFirstResult

public int getFirstResult()

getHints

public Map<String,Object> getHints()

Returns a Map containing query hints set by user.

Returns:

the hints

setParameter

public <T> javax.persistence.Query setParameter(javax.persistence.Parameter<T> paramParameter,
                                       T paramT)

setParameter

public javax.persistence.Query setParameter(javax.persistence.Parameter<Calendar> paramParameter,
                                   Calendar paramCalendar,
                                   javax.persistence.TemporalType paramTemporalType)

setParameter

public javax.persistence.Query setParameter(javax.persistence.Parameter<Date> paramParameter,
                                   Date paramDate,
                                   javax.persistence.TemporalType paramTemporalType)

getParameters

public Set<javax.persistence.Parameter<?>> getParameters()

getParameter

public javax.persistence.Parameter<?> getParameter(String paramString)

getParameter

public <T> javax.persistence.Parameter<T> getParameter(String paramString,
                                              Class<T> paramClass)

getParameter

public javax.persistence.Parameter<?> getParameter(int paramInt)

getParameter

public <T> javax.persistence.Parameter<T> getParameter(int paramInt,
                                              Class<T> paramClass)

isBound

public boolean isBound(javax.persistence.Parameter<?> paramParameter)

getParameterValue

public <T> T getParameterValue(javax.persistence.Parameter<T> paramParameter)

getParameterValue

public Object getParameterValue(String paramString)

getParameterValue

public Object getParameterValue(int paramInt)

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

setLockMode

public javax.persistence.Query setLockMode(javax.persistence.LockModeType paramLockModeType)

getLockMode

public javax.persistence.LockModeType getLockMode()

unwrap

public <T> T unwrap(Class<T> paramClass)

getParameterByName

private javax.persistence.Parameter getParameterByName(String name)

Returns specific parameter instance for given name.

Parameters:

name - parameter name.

Returns:

parameter

getParameterByOrdinal

private javax.persistence.Parameter getParameterByOrdinal(Integer position)

Returns parameter by ordinal.

Parameters:

position - position

Returns:

parameter instance.

onNativeCondition

private void onNativeCondition()

Method to handle get/set Parameter supplied for native query.

onTypeCheck

private <T> javax.persistence.Parameter<T> onTypeCheck(Class<T> paramClass,
                                             javax.persistence.Parameter<T> parameter)

Validated parameter's class with input paramClass. Returns back parameter if it matches, else throws an IllegalArgumentException.

Type Parameters:

T - type of class.

Parameters:

paramClass - expected class type.

parameter - parameter

Returns:

parameter if it matches, else throws an IllegalArgumentException.

onParameterValue

private List<Object> onParameterValue(String paramString)

Returns parameter value.

Parameters:

paramString - parameter as string.

Returns:

value of parameter.

getColumns

protected String[] getColumns(String[] columns,
                  EntityMetadata m)

Gets the columns.

Parameters:

columns - the columns

m - the m

Returns:

the columns

setFetchSize

public void setFetchSize(Integer fetchsize)

Description copied from interface: Query

To set fetch size for query.

Specified by:

setFetchSize in interface Query

getFetchSize

public Integer getFetchSize()

Specified by:

getFetchSize in interface Query

Returns:

fetch size value.

applyTTL

public void applyTTL(int ttlInSeconds)

Description copied from interface: Query

add support to enable TTL for UPDATE/INSERT/DELETE queries.

Specified by:

applyTTL in interface Query

close

public abstract void close()

Description copied from interface: Query

Reinstate .

Specified by:

close in interface Query

iterate

public abstract <E> Iterator<E> iterate()

Description copied from interface: Query

Iterates over result.

Specified by:

iterate in interface Query

Returns:

handlePostEvent

protected void handlePostEvent()

Handle post event callbacks.

fetch

protected List fetch()

Returns collection of fetched entities.

Returns:

the list

onValidateSingleResult

protected void onValidateSingleResult(List results)

On validate single result.

Parameters:

results - the results

onReturnResults

protected Object onReturnResults(List results)

On return results.

Parameters:

results - the results

Returns:

the object

isRelational

private boolean isRelational(EntityMetadata m)

Returns true, if associated entity holds relational references(e.g. @OneToMany etc.) else false.

Parameters:

m - entity metadata

Returns:

true, if holds relation else false

assignReferenceToProxy

private void assignReferenceToProxy(List results)

If returned collection of object holds a reference to.

Parameters:

results - the results