org.datanucleus.store.neodatis.query

Class NativeQuery

java.lang.Object

org.datanucleus.store.query.Query

org.datanucleus.store.query.AbstractJavaQuery

org.datanucleus.store.neodatis.query.NativeQuery

All Implemented Interfaces:

Serializable, org.datanucleus.ExecutionContextListener

public class NativeQuery
extends org.datanucleus.store.query.AbstractJavaQuery

Representation of a NeoDatis "Native" query for use in DataNucleus. Created by passing in the NativeQuery object.

See Also:

Serialized Form

Nested Class Summary

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

org.datanucleus.store.query.Query.SubqueryDefinition

Field Summary

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

candidateCollection, singleString

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_CLOSE_RESULTS_AT_EC_CLOSE, 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, 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
NativeQuery(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec) Constructs a new query instance that uses the given persistence manager.
NativeQuery(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec, Object nativeQuery) Constructor for a query using NeoDatis "native" query language.

Method Summary

Modifier and Type	Method and Description
void	compileGeneric(Map parameterValues)
protected void	compileInternal(Map parameterValues) Method to compile the query.
String	getSingleStringQuery() Method to return the query as a single string.
protected boolean	isCompiled() Method to return if the query is compiled.
protected Object	performExecute(Map parameters) Method to execute the query.
protected boolean	shouldReturnSingleRow() Convenience method to return whether the query should return a single row.

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

dereferenceFilter, discardCompiled, evaluateInMemory, performDeletePersistentAll, setCandidates, setCandidates, toString

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, declareExplicitParameters, declareExplicitVariables, declareImports, deepFindSymbolForParameterInCompilation, deletePersistentAll, deletePersistentAll, deletePersistentAll, deregisterTask, equals, execute, executeQuery, executeWithArray, executeWithMap, executionContextClosing, getBooleanExtensionProperty, getCandidateClass, getCandidateClassMetaData, 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, isSubclasses, isUnique, isUnmodifiable, 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, supportsTimeout, useCaching, useFetchPlan, useResultsCaching

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeQuery

public NativeQuery(org.datanucleus.store.StoreManager storeMgr,
                   org.datanucleus.ExecutionContext ec)

Constructs a new query instance that uses the given persistence manager.

Parameters:

storeMgr - StoreManager for this query

ec - execution context

NativeQuery

public NativeQuery(org.datanucleus.store.StoreManager storeMgr,
                   org.datanucleus.ExecutionContext ec,
                   Object nativeQuery)

Constructor for a query using NeoDatis "native" query language. The final parameter must implement "org.neodatis.odb.core.query.nq.NativeQuery".

Parameters:

storeMgr - StoreManager for this query

ec - execution context

nativeQuery - The native query

Throws:

org.datanucleus.exceptions.NucleusUserException - When the second parameter isn't an implementation of a Query

Method Detail

compileGeneric

public void compileGeneric(Map parameterValues)

Specified by:

compileGeneric in class org.datanucleus.store.query.AbstractJavaQuery

compileInternal

protected void compileInternal(Map parameterValues)

Method to compile the query. We have nothing to compile with NeoDatis native queries since all is done at execution.

Specified by:

compileInternal in class org.datanucleus.store.query.Query

isCompiled

protected boolean isCompiled()

Method to return if the query is compiled.

Overrides:

isCompiled in class org.datanucleus.store.query.Query

Returns:

Whether it is compiled

performExecute

protected Object performExecute(Map parameters)

Method to execute the query.

Specified by:

performExecute in class org.datanucleus.store.query.Query

Parameters:

parameters - Map of parameter values keyed by the name

Returns:

The query result

shouldReturnSingleRow

protected boolean shouldReturnSingleRow()

Convenience method to return whether the query should return a single row.

Overrides:

shouldReturnSingleRow in class org.datanucleus.store.query.Query

Returns:

Whether a single row should result

getSingleStringQuery

public String getSingleStringQuery()

Method to return the query as a single string.

Specified by:

getSingleStringQuery in class org.datanucleus.store.query.AbstractJavaQuery

Returns:

The single string