org.jpox.store.query
Class AbstractJDOQLQuery

java.lang.Object
  org.jpox.store.query.Query
      org.jpox.store.query.AbstractJavaQuery
          org.jpox.store.query.AbstractJDOQLQuery

All Implemented Interfaces:

java.io.Serializable

public abstract class AbstractJDOQLQuery
extends AbstractJavaQuery

Abstract representation of a JDOQL query used by JPOX. The query can be specified via method calls, or via a single-string form.

See Also:

Query, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jpox.store.query.Query

Query.SubqueryDefinition

Field Summary

Fields inherited from class org.jpox.store.query.AbstractJavaQuery

candidateCollection, candidateExtent, distinct, resultMetaData, rof, singleString, userDefinedScalarExpressions

Fields inherited from class org.jpox.store.query.Query

BULK_DELETE, BULK_UPDATE, candidateClass, candidateClassName, explicitParameters, explicitVariables, extensions, filter, from, fromInclNo, grouping, having, ignoreCache, implicitParameters, imports, isCompiled, LOCALISER, om, ordering, parameterNames, parsedImports, queryResults, range, result, resultClass, resultClassName, SELECT, subclasses, subqueries, toExclNo, type, unique, unmodifiable, update

Constructor Summary

AbstractJDOQLQuery(ObjectManager om)
Constructor.

Method Summary

java.lang.String	getSingleStringQuery() Method to take the defined parameters for the query and form a single string.
protected long	performDeletePersistentAll(java.util.Map parameters) Execute the query to delete persistent objects.
void	setGrouping(java.lang.String grouping) Set the grouping specification for the result Collection.

Methods inherited from class org.jpox.store.query.AbstractJavaQuery

discardCompiled, getCandidateCollection, getCandidateExtent, getParsedImports, getResultSetMetaData, getUserDefinedScalarExpressions, registerScalarExpression, registerScalarExpressions, resultHasOnlyAggregates, setCandidates, setCandidates, toString

Methods inherited from class org.jpox.store.query.Query

addExtension, addSubquery, applyRangeChecks, assertIsModifiable, close, closeAll, compile, compileInternal, declareExplicitParameters, declareExplicitVariables, declareImports, deletePersistentAll, deletePersistentAll, deletePersistentAll, equals, execute, execute, execute, execute, executeWithArray, executeWithMap, getCandidateClass, getCandidateClassName, getExplicitParameters, getExplicitVariables, getExtension, getFetchPlan, getFilter, getFrom, getGrouping, getHaving, getIgnoreCache, getImports, getObjectManager, getOrdering, getRange, getRangeFromIncl, getRangeToExcl, getResult, getResultClass, getResultClassName, getStoreManager, getSubqueryForVariable, getType, getUpdate, hashCode, hasSubqueryForVariable, isCompiled, isSubclasses, isUnique, isUnmodifiable, performExecute, prepareDatastore, resolveClassDeclaration, setCandidateClassName, setClass, setExtensions, setFetchPlan, setFilter, setFrom, setHaving, setIgnoreCache, setImplicitParameter, setImplicitParameter, setOrdering, setRange, setRange, setResult, setResultClass, setResultClassName, setResultMetaData, setSubclasses, setType, setUnique, setUnmodifiable, setUpdate, shouldReturnSingleRow

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractJDOQLQuery

public AbstractJDOQLQuery(ObjectManager om)

Constructor.

Parameters:

om - ObjectManager

Method Detail

setGrouping

public void setGrouping(java.lang.String grouping)

Set the grouping specification for the result Collection.

Overrides:

setGrouping in class Query

Parameters:

grouping - the grouping specification.

See Also:

Query.setGrouping(java.lang.String)

getSingleStringQuery

public java.lang.String getSingleStringQuery()

Method to take the defined parameters for the query and form a single string. This is used to print out the query for logging.

Specified by:

getSingleStringQuery in class AbstractJavaQuery

Returns:

The single string

performDeletePersistentAll

protected long performDeletePersistentAll(java.util.Map parameters)

Execute the query to delete persistent objects.

Specified by:

performDeletePersistentAll in class Query

Parameters:

parameters - the Map containing all of the parameters.

Returns:

the number of deleted objects.