|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.openjpa.persistence.AbstractQuery<X>
org.apache.openjpa.persistence.QueryImpl<X>
public class QueryImpl<X>
Implementation of Query interface.
| Field Summary |
|---|
| Fields inherited from class org.apache.openjpa.persistence.AbstractQuery |
|---|
_boundParams, _convertPositionalParams, _declaredParams, _em, _qmd, _relaxBindParameterTypeChecking |
| Fields inherited from interface org.apache.openjpa.persistence.OpenJPAQuery |
|---|
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION, HINT_RESULT_COUNT, OP_DELETE, OP_SELECT, OP_UPDATE |
| Constructor Summary | |
|---|---|
QueryImpl(EntityManagerImpl em,
Query query)
Deprecated. |
|
QueryImpl(EntityManagerImpl em,
RuntimeExceptionTranslator ret,
Query query)
Deprecated. |
|
QueryImpl(EntityManagerImpl em,
RuntimeExceptionTranslator ret,
Query query,
QueryMetaData qmd)
Constructor; supply factory exception translator and delegate. |
|
| Method Summary | ||
|---|---|---|
OpenJPAQuery<X> |
addAggregateListener(AggregateListener listener)
Register an aggregate listener for the query. |
|
OpenJPAQuery<X> |
addFilterListener(FilterListener listener)
Register a filter listener for the query. |
|
(package private) void |
assertJPQLOrCriteriaQuery()
Asserts that this query is a JPQL or Criteria Query. |
|
protected void |
assertOpen()
|
|
OpenJPAQuery<X> |
closeAll()
Close all open query results. |
|
OpenJPAQuery<X> |
compile()
Compile the query. |
|
boolean |
equals(Object other)
|
|
int |
executeUpdate()
|
|
Collection<?> |
getCandidateCollection()
Return the candidate collection, or null if an
extent was specified instead of a collection. |
|
String[] |
getDataStoreActions(Map params)
Returns a description of the commands that will be sent to the datastore in order to execute this query. |
|
Query |
getDelegate()
Delegate. |
|
OpenJPAEntityManager |
getEntityManager()
The owning entity manager. |
|
FetchPlan |
getFetchPlan()
Fetch plan for controlling the loading of results. |
|
int |
getFirstResult()
Return the 0-based start index for the returned results. |
|
FlushModeType |
getFlushMode()
Return the current flush mode. |
|
Map<String,Object> |
getHints()
Get all the active hints and their values. |
|
boolean |
getIgnoreChanges()
Whether to ignore changes in the current transaction. |
|
String |
getLanguage()
Query language. |
|
LockModeType |
getLockMode()
|
|
int |
getMaxResults()
Return the maximum number of results to retrieve. |
|
QueryOperationType |
getOperation()
Query operation type. |
|
OrderedMap<Object,Class<?>> |
getParamTypes()
|
|
String |
getQueryString()
Query string. |
|
Class |
getResultClass()
Query result element type. |
|
List |
getResultList()
|
|
X |
getSingleResult()
Execute a query that returns a single result. |
|
Set<String> |
getSupportedHints()
Gets hints supported by this query. |
|
int |
hashCode()
|
|
boolean |
hasSubclasses()
Whether subclasses are included in the query results. |
|
(package private) void |
ignorePreparedQuery()
Ignores this query from PreparedQueryCache by recreating the original query if it has been cached. |
|
(package private) boolean |
invalidatePreparedQuery()
Remove this query from PreparedQueryCache. |
|
protected void |
lock()
|
|
OpenJPAQuery<X> |
removeAggregateListener(AggregateListener listener)
Remove an aggregate listener from the query. |
|
OpenJPAQuery<X> |
removeFilterListener(FilterListener listener)
Remove a filter listener from the query. |
|
OpenJPAQuery<X> |
setCandidateCollection(Collection coll)
Set a collection of candidates. |
|
OpenJPAQuery<X> |
setFirstResult(int startPosition)
|
|
OpenJPAQuery<X> |
setFlushMode(FlushModeType flushMode)
|
|
OpenJPAQuery<X> |
setHint(String key,
Object value)
|
|
(package private) QueryImpl |
setId(String id)
|
|
OpenJPAQuery<X> |
setIgnoreChanges(boolean ignore)
Whether to ignore changes in the current transaction. |
|
TypedQuery<X> |
setLockMode(LockModeType lockMode)
Sets lock mode on the given query. |
|
OpenJPAQuery<X> |
setMaxResults(int max)
|
|
OpenJPAQuery<X> |
setResultClass(Class cls)
Query result element type. |
|
OpenJPAQuery<X> |
setSubclasses(boolean subs)
Whether subclasses are included in the query results. |
|
String |
toString()
|
|
protected void |
unlock()
|
|
|
unwrap(Class<T> cls)
Unwraps this receiver to an instance of the given class, if possible. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public QueryImpl(EntityManagerImpl em,
RuntimeExceptionTranslator ret,
Query query,
QueryMetaData qmd)
em - The EntityManager which created this queryret - Exception translator for this queryquery - The underlying "kernel" query.
public QueryImpl(EntityManagerImpl em,
RuntimeExceptionTranslator ret,
Query query)
public QueryImpl(EntityManagerImpl em,
Query query)
| Method Detail |
|---|
public Query getDelegate()
public OpenJPAEntityManager getEntityManager()
OpenJPAQuery
getEntityManager in interface OpenJPAQuery<X>public String getLanguage()
OpenJPAQuery
getLanguage in interface OpenJPAQuery<X>public QueryOperationType getOperation()
OpenJPAQuery
getOperation in interface OpenJPAQuery<X>public FetchPlan getFetchPlan()
OpenJPAQuery
getFetchPlan in interface OpenJPAQuery<X>public String getQueryString()
OpenJPAQuery
getQueryString in interface OpenJPAQuery<X>public boolean getIgnoreChanges()
OpenJPAQuery
getIgnoreChanges in interface OpenJPAQuery<X>public OpenJPAQuery<X> setIgnoreChanges(boolean ignore)
OpenJPAQuery
setIgnoreChanges in interface OpenJPAQuery<X>public OpenJPAQuery<X> addFilterListener(FilterListener listener)
OpenJPAQuerySPI
addFilterListener in interface OpenJPAQuery<X>addFilterListener in interface OpenJPAQuerySPI<X>public OpenJPAQuery<X> removeFilterListener(FilterListener listener)
OpenJPAQuerySPI
removeFilterListener in interface OpenJPAQuery<X>removeFilterListener in interface OpenJPAQuerySPI<X>public OpenJPAQuery<X> addAggregateListener(AggregateListener listener)
OpenJPAQuerySPI
addAggregateListener in interface OpenJPAQuery<X>addAggregateListener in interface OpenJPAQuerySPI<X>public OpenJPAQuery<X> removeAggregateListener(AggregateListener listener)
OpenJPAQuerySPI
removeAggregateListener in interface OpenJPAQuery<X>removeAggregateListener in interface OpenJPAQuerySPI<X>public Collection<?> getCandidateCollection()
OpenJPAQuerynull if an
extent was specified instead of a collection.
getCandidateCollection in interface OpenJPAQuery<X>public OpenJPAQuery<X> setCandidateCollection(Collection coll)
OpenJPAQuery
setCandidateCollection in interface OpenJPAQuery<X>public Class getResultClass()
OpenJPAQuery
getResultClass in interface OpenJPAQuery<X>public OpenJPAQuery<X> setResultClass(Class cls)
OpenJPAQuery
setResultClass in interface OpenJPAQuery<X>public boolean hasSubclasses()
OpenJPAQuery
hasSubclasses in interface OpenJPAQuery<X>public OpenJPAQuery<X> setSubclasses(boolean subs)
OpenJPAQuery
setSubclasses in interface OpenJPAQuery<X>public int getFirstResult()
OpenJPAQuery
getFirstResult in interface QuerygetFirstResult in interface OpenJPAQuery<X>public OpenJPAQuery<X> setFirstResult(int startPosition)
setFirstResult in interface QuerysetFirstResult in interface TypedQuery<X>setFirstResult in interface OpenJPAQuery<X>public int getMaxResults()
OpenJPAQueryInteger.MAX_VALUE for no limit.
getMaxResults in interface QuerygetMaxResults in interface OpenJPAQuery<X>public OpenJPAQuery<X> setMaxResults(int max)
setMaxResults in interface QuerysetMaxResults in interface TypedQuery<X>setMaxResults in interface OpenJPAQuery<X>public OpenJPAQuery<X> compile()
OpenJPAQuery
compile in interface OpenJPAQuery<X>public List getResultList()
getResultList in interface QuerygetResultList in interface TypedQuery<X>public X getSingleResult()
getSingleResult in interface QuerygetSingleResult in interface TypedQuery<X>public int executeUpdate()
executeUpdate in interface Querypublic FlushModeType getFlushMode()
OpenJPAQuery
getFlushMode in interface QuerygetFlushMode in interface OpenJPAQuery<X>public OpenJPAQuery<X> setFlushMode(FlushModeType flushMode)
setFlushMode in interface QuerysetFlushMode in interface TypedQuery<X>setFlushMode in interface OpenJPAQuery<X>void assertJPQLOrCriteriaQuery()
public OpenJPAQuery<X> closeAll()
OpenJPAQuery
closeAll in interface OpenJPAQuery<X>public String[] getDataStoreActions(Map params)
OpenJPAQuery
getDataStoreActions in interface OpenJPAQuery<X>params - the named parameter map for the query invocationpublic LockModeType getLockMode()
getLockMode in interface Querypublic TypedQuery<X> setLockMode(LockModeType lockMode)
setLockMode in interface QuerysetLockMode in interface TypedQuery<X>ignorePreparedQuery()public int hashCode()
hashCode in class Objectpublic boolean equals(Object other)
equals in class Objectpublic Map<String,Object> getHints()
getHints in interface Query
public OpenJPAQuery<X> setHint(String key,
Object value)
setHint in interface QuerysetHint in interface TypedQuery<X>setHint in interface OpenJPAQuery<X>public Set<String> getSupportedHints()
OpenJPAQuery
getSupportedHints in interface OpenJPAQuery<X>public <T> T unwrap(Class<T> cls)
unwrap in interface Queryif - the given class is null, generic Object.class or a class
that is not wrapped by this receiver.boolean invalidatePreparedQuery()
void ignorePreparedQuery()
QueryImpl setId(String id)
protected void lock()
lock in class AbstractQuery<X>protected void unlock()
unlock in class AbstractQuery<X>protected void assertOpen()
assertOpen in class AbstractQuery<X>public OrderedMap<Object,Class<?>> getParamTypes()
getParamTypes in class AbstractQuery<X>public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||