DelegatingQuery (OpenJPA 0.9.0-incubating API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.openjpa.kernel
Class DelegatingQuery

java.lang.Object
  org.apache.openjpa.kernel.DelegatingQuery

All Implemented Interfaces:: Serializable, Query, QueryContext, QueryFlushModes, QueryOperations

public class DelegatingQuery
extends Object
implements Query
extends Object
implements Query

Delegating query that can also perform exception translation for use in facades.

Since:: 0.4.0
Author:: Abe White
See Also:: Serialized Form

Field Summary

Fields inherited from interface org.apache.openjpa.kernel.QueryOperations
`OP_DELETE, OP_SELECT, OP_UPDATE`

Fields inherited from interface org.apache.openjpa.kernel.QueryFlushModes
`FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION`

Constructor Summary
`DelegatingQuery(Query query)` Constructor; supply delegate.
`DelegatingQuery(Query query, RuntimeExceptionTranslator trans)` Constructor; supply delegate and exception translator.

Method Summary
`void`	`addAggregateListener(AggregateListener listener)` Register an aggregate listener for the query.
`void`	`addFilterListener(FilterListener listener)` Register a filter listener for the query.
`void`	`assertNotReadOnly()` Assert that the query is not read-only.
`void`	`assertNotSerialized()` Check that the query has not been serialized, which causes it to lose its association with its Broker.
`void`	`assertOpen()` Assert that the query's broker is still open.
`Class`	`classForName(String name, String[] imports)` Helper method to instantiate the class with the given name, taking into account the query's candidate package, automatic imports, and the given imports (if any).
`void`	`closeAll()` Close all open query results.
`void`	`closeResources()` Close query results that are consuming resources.
`void`	`compile()` Compile the query.
`void`	`declareParameters(String params)` Declared parameters, for query languages that use them.
`long`	`deleteAll()` Deletes all of the instances that are satisfied by the query.
`long`	`deleteAll(Map parameterMap)` Deletes all of the instances that are satisfied by the query.
`long`	`deleteAll(Object[] parameters)` Deletes all of the instances that are satisfied by the query.
`Number`	`deleteInMemory(StoreQuery.Executor ex, Object[] params)` Helper method to delete the objects found by executing a query on the given executor.
`boolean`	`equals(Object other)`
`Object`	`execute()` Execute.
`Object`	`execute(Map params)` Execute with parameter map.
`Object`	`execute(Object[] params)` Execute with parameter array.
`ClassMetaData[]`	`getAccessPathMetaDatas()` Return the classes that affect this query.
`AggregateListener`	`getAggregateListener(String tag)` Return the filter listener for the given tag, or null.
`Collection`	`getAggregateListeners()` The set of aggregate listeners.
`String`	`getAlias()` If this query is not a projection but places candidate results into a result class under an alias, return that alias.
`Broker`	`getBroker()` The broker that generated this query.
`Collection`	`getCandidateCollection()` Return the candidate collection, or `null` if an extent was specified instead of a collection.
`Extent`	`getCandidateExtent()` Return the candidate extent, or `null` if a collection was specified instead of an extent.
`Class`	`getCandidateType()` Return the class of the objects that this query will return, or `null` if this information is not available / not relevant.
`Object`	`getCompilation()` Return the query's compilation state.
`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()` Return the direct delegate.
`long`	`getEndRange()` Return the 0-based exclusive end index for the returned results, or `Long.MAX_VALUE` for no limit.
`FetchConfiguration`	`getFetchConfiguration()` Return the fetch configuration for this query.
`FilterListener`	`getFilterListener(String tag)` Return the filter listener for the given tag, or null.
`Collection`	`getFilterListeners()` The set of filter listeners.
`boolean`	`getIgnoreChanges()` Whether to ignore changes in the current transaction.
`Query`	`getInnermostDelegate()` Return the native delegate.
`String`	`getLanguage()` The query language.
`int`	`getOperation()` Returns the operation that this query will be expected to perform.
`String`	`getParameterDeclaration()` The parameter declaration.
`LinkedMap`	`getParameterTypes()` Return a map of parameter name to type for this query.
`String[]`	`getProjectionAliases()` If this query is a projection, return the projection aliases.
`Class[]`	`getProjectionTypes()` If this query is a projection, return the projection types.
`Query`	`getQuery()` Return the query for this context.
`String`	`getQueryString()` The query string.
`String`	`getResultMappingName()` Name of a mapping from the result data to its object representation.
`Class`	`getResultMappingScope()` Scope of a mapping from the result data to its object representation.
`Class`	`getResultType()` Returns the result class that has been set through `QueryContext.setResultType(java.lang.Class)`, or null if none.
`long`	`getStartRange()` Return the 0-based start index for the returned results.
`StoreContext`	`getStoreContext()` The persistence context for the query.
`Map`	`getUpdates()` If this query is a bulk update, return a map of the `FieldMetaData`s to `Constant`s.
`boolean`	`hasGrouping()` Return true if the query uses grouping.
`int`	`hashCode()`
`boolean`	`hasSubclasses()` Whether query results will include subclasses of the candidate class.
`boolean`	`isAggregate()` Return true if the query is an aggregate.
`boolean`	`isReadOnly()` Whether the query has been marked read-only.
`boolean`	`isUnique()` The unique flag.
`void`	`lock()` Synchronize on the query's internal lock.
`void`	`removeAggregateListener(AggregateListener listener)` Remove an aggregate listener from the query.
`void`	`removeFilterListener(FilterListener listener)` Remove a filter listener from the query.
`void`	`setCandidateCollection(Collection coll)` Set a collection of candidates.
`void`	`setCandidateExtent(Extent extent)` Set the candidate extent.
`void`	`setCandidateType(Class cls, boolean subs)` Set the candidate type.
`void`	`setIgnoreChanges(boolean ignore)` Whether to ignore changes in the current transaction.
`boolean`	`setQuery(Object query)` The query string or template.
`void`	`setRange(long start, long end)` Set the range of results to return.
`void`	`setReadOnly(boolean readOnly)` Whether the query has been marked read-only.
`void`	`setResultMapping(Class scope, String name)` Name and scope of a mapping from the result data to its object representation.
`void`	`setResultType(Class cls)` Specify the type of object in which the result of evaluating this query.
`void`	`setUnique(boolean unique)` Specify that the query will return only 1 result, rather than a collection.
`protected RuntimeException`	`translate(RuntimeException re)` Translate the OpenJPA exception.
`void`	`unlock()` Unlock the query's internal lock.
`long`	`updateAll()` Performs an update of the instances that are satisfied by the query.
`long`	`updateAll(Map parameterMap)` Performs an update of the instances that are satisfied by the query.
`long`	`updateAll(Object[] parameters)` Performs an update of the instances that are satisfied by the query.
`Number`	`updateInMemory(StoreQuery.Executor ex, Object[] params)` Helper method to update the objects found by executing a query on the given executor.

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

Constructor Detail

DelegatingQuery

public DelegatingQuery(Query query)

Constructor; supply delegate.

DelegatingQuery

public DelegatingQuery(Query query,
                       RuntimeExceptionTranslator trans)

Constructor; supply delegate and exception translator.

Method Detail

getDelegate

public Query getDelegate()

Return the direct delegate.

getInnermostDelegate

public Query getInnermostDelegate()

Return the native delegate.

hashCode

public int hashCode()

Overrides:: hashCode in class Object

equals

public boolean equals(Object other)

Overrides:: equals in class Object

translate

protected RuntimeException translate(RuntimeException re)

Translate the OpenJPA exception.

getBroker

public Broker getBroker()

Description copied from interface: Query

The broker that generated this query.

Specified by:: getBroker in interface Query