org.datanucleus.store.query

Class AbstractJavaQuery

java.lang.Object

org.datanucleus.store.query.Query

org.datanucleus.store.query.AbstractJavaQuery

All Implemented Interfaces:

Serializable, ExecutionContextListener

Direct Known Subclasses:

AbstractJDOQLQuery, AbstractJPQLQuery

public abstract class AbstractJavaQuery
extends Query

Abstract representation of a Java-based query. To be extended by Java-based query languages.

See Also:

Serialized Form

Nested Class Summary

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

Query.SubqueryDefinition

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection	candidateCollection Collection of candidates for this query.
protected String	singleString Cached form of the single string form of the query.

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

BULK_DELETE, BULK_UPDATE, candidateClass, candidateClassName, clr, compilation, ec, explicitParameters, explicitVariables, EXTENSION_CHECK_UNUSED_PARAMETERS, EXTENSION_COMPILATION_CACHED, EXTENSION_EVALUATE_IN_MEMORY, EXTENSION_FLUSH_BEFORE_EXECUTION, EXTENSION_LOAD_RESULTS_AT_COMMIT, EXTENSION_MULTITHREAD, EXTENSION_RESULT_CACHE_TYPE, EXTENSION_RESULT_SIZE_METHOD, EXTENSION_RESULTS_CACHED, EXTENSION_USE_FETCH_PLAN, extensions, filter, from, fromInclNo, fromInclParam, grouping, having, ignoreCache, implicitParameters, imports, inputParameters, LOCALISER, ordering, OTHER, parameterNames, parsedImports, queryResults, range, result, resultClass, resultClassName, resultDistinct, SELECT, storeMgr, subclasses, subqueries, tasks, toExclNo, toExclParam, type, unique, unmodifiable, update

Constructor Summary

Constructors

Constructor and Description
AbstractJavaQuery(StoreManager storeMgr, ExecutionContext ec) Constructor for a Java-based query.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	dereferenceFilter(String input) Method to expand the subqueries defined in a filter.
protected void	discardCompiled() Method to discard our current compiled query due to changes.
protected boolean	evaluateInMemory() Convenience method to return whether the query should be evaluated in-memory.
abstract String	getSingleStringQuery() Accessor for a single string form of the query.
protected long	performDeletePersistentAll(Map parameters) Execute the query to delete persistent objects.
void	setCandidates(Collection pcs) Set the candidate collection to query.
void	setCandidates(Extent pcs) Set the candidate Extent to query.
String	toString() Stringifier method

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

addExtension, addSubquery, applyImplicitParameterValueToCompilation, applyImplicitParameterValueToSubqueries, assertIsModifiable, assertIsOpen, assertSupportsCancel, cancel, cancel, cancelTaskObject, checkForMissingParameters, checkParameterTypesAgainstCompilation, checkUnusedParameters, close, closeAll, compile, compileInternal, declareExplicitParameters, declareExplicitVariables, declareImports, deepFindSymbolForParameterInCompilation, deletePersistentAll, deletePersistentAll, deletePersistentAll, deregisterTask, equals, execute, executeQuery, executeWithArray, executeWithMap, executionContextClosing, getBooleanExtensionProperty, getCandidateClass, getCandidateClassName, getCompilation, getDatastoreReadTimeoutMillis, getDatastoreWriteTimeoutMillis, getExecutionContext, getExplicitParameters, getExplicitVariables, getExtension, getExtensions, getFetchPlan, getFilter, getFrom, getGrouping, getHaving, getIgnoreCache, getImplicitParameters, getImports, getInputParameters, getLanguage, getNativeQuery, getOrdering, getParameterMapForValues, getParsedImports, getQueryManager, getRange, getRangeFromIncl, getRangeFromInclParam, getRangeToExcl, getRangeToExclParam, getResult, getResultClass, getResultClassName, getResultDistinct, getSerializeRead, getStoreManager, getStringExtensionProperty, getSubqueryForVariable, getSupportedExtensions, getType, getUpdate, hashCode, hasSubqueryForVariable, isCompiled, isSubclasses, isUnique, isUnmodifiable, performExecute, prepareDatastore, processesRangeInDatastoreQuery, registerTask, resolveClassDeclaration, setCacheResults, setCandidateClass, setCandidateClassName, setCompilation, setDatastoreReadTimeoutMillis, setDatastoreWriteTimeoutMillis, setExtensions, setFetchPlan, setFilter, setFrom, setGrouping, setHaving, setIgnoreCache, setImplicitParameter, setImplicitParameter, setOrdering, setRange, setRange, setResult, setResultClass, setResultClassName, setResultDistinct, setResultMetaData, setSerializeRead, setSubclasses, setType, setUnique, setUnmodifiable, setUpdate, shouldReturnSingleRow, supportsTimeout, useCaching, useFetchPlan, useResultsCaching

Methods inherited from class java.lang.Object

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

Field Detail

candidateCollection

protected transient Collection candidateCollection

Collection of candidates for this query.

singleString

protected String singleString

Cached form of the single string form of the query.

Constructor Detail

AbstractJavaQuery

public AbstractJavaQuery(StoreManager storeMgr,
                 ExecutionContext ec)

Constructor for a Java-based query.

Parameters:

storeMgr - StoreManager for this query

ec - ExecutionContext

Method Detail

setCandidates

public void setCandidates(Extent pcs)

Set the candidate Extent to query. Passing in null clears off the current candidate Extent.

Specified by:

setCandidates in class Query

Parameters:

pcs - the Candidate Extent.

setCandidates

public void setCandidates(Collection pcs)

Set the candidate collection to query. Passing in null clears off the current candidate collection.

Specified by:

setCandidates in class Query

Parameters:

pcs - the Candidate collection.

discardCompiled

protected void discardCompiled()

Method to discard our current compiled query due to changes.

Overrides:

discardCompiled in class Query

See Also:

Query.discardCompiled()

performDeletePersistentAll

protected long performDeletePersistentAll(Map parameters)

Execute the query to delete persistent objects.

Overrides:

performDeletePersistentAll in class Query

Parameters:

parameters - the Map containing all of the parameters.

Returns:

the number of deleted objects.

getSingleStringQuery

public abstract String getSingleStringQuery()

Accessor for a single string form of the query.

Returns:

Single string form of the query.

toString

public String toString()

Stringifier method

Overrides:

toString in class Object

Returns:

Single-string form of this query.

evaluateInMemory

protected boolean evaluateInMemory()

Convenience method to return whether the query should be evaluated in-memory.

Returns:

Use in-memory evaluation?

dereferenceFilter

protected String dereferenceFilter(String input)

Method to expand the subqueries defined in a filter.

Parameters:

input - the input string

Returns:

The filter expanded