com.haulmont.cuba.core.sys

Class QueryImpl<T>

java.lang.Object

com.haulmont.cuba.core.sys.QueryImpl<T>

All Implemented Interfaces:

Query, TypedQuery<T>

@Component(value="cuba_Query")
 @Scope(value="prototype")
public class QueryImpl<T>
extends java.lang.Object
implements TypedQuery<T>

Implementation of TypedQuery interface based on EclipseLink.

Field Summary

Fields inherited from interface com.haulmont.cuba.core.Query

NAME

Constructor Summary

Constructors

Constructor and Description
QueryImpl(io.jmix.data.JmixQuery delegate)
QueryImpl(io.jmix.data.JmixQuery delegate, java.lang.Class resultClass)

Method Summary

Modifier and Type	Method and Description
TypedQuery<T>	addView(java.lang.Class<? extends io.jmix.core.Entity> entityClass, java.lang.String fetchPlanName) Adds View for this Query instance.
TypedQuery<T>	addView(io.jmix.core.FetchPlan fetchPlan) Adds View for this Query instance.
TypedQuery<T>	addViewName(java.lang.String fetchPlanName) Adds View for this Query instance.
int	executeUpdate() Execute an update or delete statement.
javax.persistence.Query	getDelegate()
T	getFirstResult() Execute a SELECT query. Returns null if there is no result. Returns first result if more than one result.
java.lang.String	getQueryString() Get the query string.
java.util.List<T>	getResultList() Execute a SELECT query and return the query results as a List.
T	getSingleResult() Execute a SELECT query that returns a single result.
TypedQuery<T>	setCacheable(boolean cacheable) Set query results to be cached
TypedQuery<T>	setFirstResult(int firstResult) Set the position of the first result to retrieve.
TypedQuery<T>	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode type to be used for the query execution.
TypedQuery<T>	setHint(java.lang.String hintName, java.lang.Object value) Set a query property or hint.
TypedQuery<T>	setLockMode(javax.persistence.LockModeType lockMode) Set the lock mode type to be used for the query execution.
TypedQuery<T>	setMaxResults(int maxResults) Set the maximum number of results to retrieve.
TypedQuery<T>	setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
TypedQuery<T>	setParameter(int position, java.lang.Object value) Bind an argument to a positional parameter.
TypedQuery<T>	setParameter(int position, java.lang.Object value, boolean implicitConversions) Bind an argument to a positional parameter.
TypedQuery<T>	setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
TypedQuery<T>	setParameter(java.lang.String name, java.lang.Object value) Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
TypedQuery<T>	setParameter(java.lang.String name, java.lang.Object value, boolean implicitConversions) Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
TypedQuery<T>	setQueryString(java.lang.String queryString) Set the query string.
void	setSingleResultExpected(boolean singleResultExpected)
TypedQuery<T>	setView(java.lang.Class<? extends io.jmix.core.Entity> entityClass, java.lang.String viewName) Set View for this Query instance.
TypedQuery<T>	setView(io.jmix.core.FetchPlan fetchPlan) Set View for this Query instance.
TypedQuery<T>	setViewName(java.lang.String fetchPlanName) Set View for this Query instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryImpl

public QueryImpl(io.jmix.data.JmixQuery delegate,
                 java.lang.Class resultClass)

QueryImpl

public QueryImpl(io.jmix.data.JmixQuery delegate)

Method Detail

getResultList

public java.util.List<T> getResultList()

Description copied from interface: Query

Execute a SELECT query and return the query results as a List.

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface TypedQuery<T>

Returns:

a list of the results

getSingleResult

public T getSingleResult()

Description copied from interface: Query

Execute a SELECT query that returns a single result.

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface TypedQuery<T>

Returns:

the result

getFirstResult

@Nullable
public T getFirstResult()

Description copied from interface: Query

Execute a SELECT query.
Returns null if there is no result.
Returns first result if more than one result.

Specified by:

getFirstResult in interface Query

Specified by:

getFirstResult in interface TypedQuery<T>

Returns:

the result

executeUpdate

public int executeUpdate()

Description copied from interface: Query

Execute an update or delete statement.

Specified by:

executeUpdate in interface Query

Returns:

the number of entities updated or deleted

setMaxResults

public TypedQuery<T> setMaxResults(int maxResults)

Description copied from interface: Query

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface TypedQuery<T>

Returns:

the same query instance

setFirstResult

public TypedQuery<T> setFirstResult(int firstResult)

Description copied from interface: Query

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface TypedQuery<T>

Parameters:

firstResult - position of the first result, numbered from 0

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(java.lang.String name,
                                  java.lang.Object value)

Description copied from interface: Query

Bind an argument to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

name - parameter name

value - parameter value. Entity instance replaced with its ID.

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(java.lang.String name,
                                  java.lang.Object value,
                                  boolean implicitConversions)

Description copied from interface: Query

Bind an argument to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

name - parameter name

value - parameter value

implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(java.lang.String name,
                                  java.util.Date value,
                                  javax.persistence.TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Date to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

name - parameter name

value - parameter value

temporalType - type of Date value

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(int position,
                                  java.lang.Object value)

Description copied from interface: Query

Bind an argument to a positional parameter.

In the query text, positional parameters are marked with ?N (e.g. ?1).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

position - parameter position, starting with 1

value - parameter value. Entity instance replaced with its ID.

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(int position,
                                  java.lang.Object value,
                                  boolean implicitConversions)

Description copied from interface: Query

Bind an argument to a positional parameter.

In the query text, positional parameters are marked with ?N (e.g. ?1).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

position - parameter position, starting with 1

value - parameter value

implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID

Returns:

the same query instance

setParameter

public TypedQuery<T> setParameter(int position,
                                  java.util.Date value,
                                  javax.persistence.TemporalType temporalType)

Description copied from interface: Query

Bind an instance of java.util.Date to a positional parameter.
In the query text, positional parameters are marked with ?N (e.g. ?1).

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface TypedQuery<T>

Parameters:

position - parameter position, starting with 1

value - parameter value

temporalType - type of Date value

Returns:

the same query instance

setLockMode

public TypedQuery<T> setLockMode(javax.persistence.LockModeType lockMode)

Description copied from interface: Query

Set the lock mode type to be used for the query execution.

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface TypedQuery<T>

Parameters:

lockMode - lock mode

Returns:

the same query instance

setView

public TypedQuery<T> setView(io.jmix.core.FetchPlan fetchPlan)

Description copied from interface: Query

Set View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

setView in interface Query

Specified by:

setView in interface TypedQuery<T>

Parameters:

fetchPlan - view instance. If null, eager fetching is performed according to JPA mappings.

Returns:

the same query instance

setViewName

public TypedQuery<T> setViewName(java.lang.String fetchPlanName)

Description copied from interface: TypedQuery

Set View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

setViewName in interface TypedQuery<T>

Parameters:

fetchPlanName - view name - must not be null

Returns:

the same query instance

setView

public TypedQuery<T> setView(java.lang.Class<? extends io.jmix.core.Entity> entityClass,
                             java.lang.String viewName)

Description copied from interface: Query

Set View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

setView in interface Query

Specified by:

setView in interface TypedQuery<T>

Parameters:

entityClass - entity class to get a view instance by the name provided

viewName - view name

Returns:

the same query instance

addView

public TypedQuery<T> addView(io.jmix.core.FetchPlan fetchPlan)

Description copied from interface: Query

Adds View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

addView in interface Query

Specified by:

addView in interface TypedQuery<T>

Parameters:

fetchPlan - view instance - must not be null

Returns:

the same query instance

addViewName

public TypedQuery<T> addViewName(java.lang.String fetchPlanName)

Description copied from interface: TypedQuery

Adds View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

addViewName in interface TypedQuery<T>

Parameters:

fetchPlanName - view name - must not be null

Returns:

the same query instance

addView

public TypedQuery<T> addView(java.lang.Class<? extends io.jmix.core.Entity> entityClass,
                             java.lang.String fetchPlanName)

Description copied from interface: Query

Adds View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Specified by:

addView in interface Query

Specified by:

addView in interface TypedQuery<T>

Parameters:

entityClass - entity class to get a view instance by the name provided

fetchPlanName - view name - must not be null

Returns:

the same query instance

getDelegate

public javax.persistence.Query getDelegate()

Specified by:

getDelegate in interface Query

Returns:

underlying implementation provided by ORM

getQueryString

public java.lang.String getQueryString()

Description copied from interface: Query

Get the query string.

Specified by:

getQueryString in interface Query

Returns:

query string

setQueryString

public TypedQuery<T> setQueryString(java.lang.String queryString)

Description copied from interface: Query

Set the query string.

Specified by:

setQueryString in interface Query

Parameters:

queryString - query string

setCacheable

public TypedQuery<T> setCacheable(boolean cacheable)

Description copied from interface: TypedQuery

Set query results to be cached

Specified by:

setCacheable in interface Query

Specified by:

setCacheable in interface TypedQuery<T>

Parameters:

cacheable - whether query is cacheable

Returns:

the same query instance

setFlushMode

public TypedQuery<T> setFlushMode(javax.persistence.FlushModeType flushMode)

Description copied from interface: TypedQuery

Set the flush mode type to be used for the query execution.

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface TypedQuery<T>

Parameters:

flushMode - flush mode

Returns:

the same query instance

setHint

public TypedQuery<T> setHint(java.lang.String hintName,
                             java.lang.Object value)

Description copied from interface: Query

Set a query property or hint.

Specified by:

setHint in interface Query

Parameters:

hintName - name of property or hint

value - value of the property or hint

Returns:

the same query instance

See Also:

QueryHints

setSingleResultExpected

public void setSingleResultExpected(boolean singleResultExpected)