oracle.toplink.essentials.queryframework

Class DataReadQuery

java.lang.Object

oracle.toplink.essentials.queryframework.DatabaseQuery

oracle.toplink.essentials.queryframework.ReadQuery

oracle.toplink.essentials.queryframework.DataReadQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, FalseUndefinedTrue

Direct Known Subclasses:

DirectReadQuery

public class DataReadQuery
extends ReadQuery

Purpose: Concrete class to perform read using raw SQL.

Responsibilities: Execute a selecting raw SQL string. This returns a Collection of the DatabaseRows representing the result set.

Since:

TOPLink/Java 1.0

Author:

Yvon Lavoie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ContainerPolicy	containerPolicy
protected boolean	useAbstractRecord

Fields inherited from class oracle.toplink.essentials.queryframework.ReadQuery

firstResult, maxRows, queryId

Fields inherited from class oracle.toplink.essentials.queryframework.DatabaseQuery

accessor, arguments, argumentTypeNames, argumentTypes, argumentValues, CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, cascadePolicy, CascadePrivateParts, descriptor, flushOnExecute, isPrepared, isUserDefined, name, NoCascading, properties, queryMechanism, session, sessionName, shouldBindAllParameters, shouldCacheStatement, shouldCloneCall, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, translationRow

Fields inherited from interface oracle.toplink.essentials.internal.helper.FalseUndefinedTrue

False, True, Undefined

Constructor Summary

Constructors

Constructor and Description
DataReadQuery() PUBLIC: Initialize the state of the query.
DataReadQuery(Call call) PUBLIC: Initialize the query to use the specified call.
DataReadQuery(java.lang.String sqlString) PUBLIC: Initialize the query to use the specified SQL string.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() INTERNAL: Clone the query.
java.lang.Object	executeDatabaseQuery() INTERNAL: Execute the query.
protected java.lang.Object	executeNonCursor() INTERNAL: The results are *not* in a cursor, build the collection.
ContainerPolicy	getContainerPolicy() PUBLIC: Return the query's ContainerPolicy.
boolean	isDataReadQuery() PUBLIC: Return if this is a data read query.
protected void	prepare() INTERNAL: Prepare the receiver for execution in a session.
void	prepareForExecution() INTERNAL: Prepare the receiver for execution in a session.
void	setContainerPolicy(ContainerPolicy containerPolicy) PUBLIC: Set the container policy.
void	setUseAbstractRecord(boolean useAbstractRecord) INTERNAL: Allow changing the default behaviour so that AbstractRecords are not returned as query results.
void	useCollectionClass(java.lang.Class concreteClass) PUBLIC: Configure the query to use an instance of the specified container class to hold the target objects.

Methods inherited from class oracle.toplink.essentials.queryframework.ReadQuery

buildObject, clonedQueryExecutionComplete, getFirstResult, getMaxRows, getQueryId, isReadQuery, setFirstResult, setMaxRows, setQueryId

Methods inherited from class oracle.toplink.essentials.queryframework.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildSelectionCriteria, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkDescriptor, checkEarlyReturn, checkForCustomQuery, checkPrepare, convertClassNamesToClasses, deploymentSetShouldMaintainCache, deploymentShouldMaintainCache, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, executeInUnitOfWork, getAccessor, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getEJBQLString, getFlushOnExecute, getName, getProperties, getProperty, getQueryMechanism, getReferenceClass, getReferenceClassName, getSelectionCriteria, getSession, getSessionName, getShouldBindAllParameters, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isDataModifyQuery, isDeleteAllQuery, isDeleteObjectQuery, isExpressionQuery, isInsertObjectQuery, isModifyAllQuery, isModifyQuery, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isWriteObjectQuery, maintainCache, prepareCall, prepareCustomQuery, prepareForRemoteExecution, removeProperty, rowFromArguments, setAccessor, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setEJBQLString, setFlushOnExecute, setIsPrepared, setIsUserDefined, setName, setProperties, setProperty, setQueryMechanism, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, setTranslationRow, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

containerPolicy

protected ContainerPolicy containerPolicy

useAbstractRecord

protected boolean useAbstractRecord

Constructor Detail

DataReadQuery

public DataReadQuery()

PUBLIC: Initialize the state of the query.

DataReadQuery

public DataReadQuery(java.lang.String sqlString)

PUBLIC: Initialize the query to use the specified SQL string.

DataReadQuery

public DataReadQuery(Call call)

PUBLIC: Initialize the query to use the specified call.

Method Detail

clone

public java.lang.Object clone()

INTERNAL: Clone the query.

Overrides:

clone in class DatabaseQuery

executeDatabaseQuery

public java.lang.Object executeDatabaseQuery()
                                      throws DatabaseException

INTERNAL: Execute the query. Perform the work to execute the SQL string.

Specified by:

executeDatabaseQuery in class DatabaseQuery

Returns:

a collection or cursor of DatabaseRows representing the result set

Throws:

DatabaseException - an error has occurred on the database

executeNonCursor

protected java.lang.Object executeNonCursor()
                                     throws DatabaseException

INTERNAL: The results are *not* in a cursor, build the collection.

Throws:

DatabaseException

getContainerPolicy

public ContainerPolicy getContainerPolicy()

PUBLIC: Return the query's ContainerPolicy.

Returns:

oracle.toplink.essentials.internal.queryframework.ContainerPolicy

isDataReadQuery

public boolean isDataReadQuery()

PUBLIC: Return if this is a data read query.

Overrides:

isDataReadQuery in class DatabaseQuery

prepare

protected void prepare()

INTERNAL: Prepare the receiver for execution in a session.

Overrides:

prepare in class DatabaseQuery

prepareForExecution

public void prepareForExecution()
                         throws QueryException

INTERNAL: Prepare the receiver for execution in a session.

Overrides:

prepareForExecution in class DatabaseQuery

Throws:

QueryException

setContainerPolicy

public void setContainerPolicy(ContainerPolicy containerPolicy)

PUBLIC: Set the container policy.

useCollectionClass

public void useCollectionClass(java.lang.Class concreteClass)

PUBLIC: Configure the query to use an instance of the specified container class to hold the target objects. The container class must implement (directly or indirectly) the Collection interface.

setUseAbstractRecord

public void setUseAbstractRecord(boolean useAbstractRecord)

INTERNAL: Allow changing the default behaviour so that AbstractRecords are not returned as query results.