oracle.toplink.essentials.queryframework

Class DeleteObjectQuery

java.lang.Object

oracle.toplink.essentials.queryframework.DatabaseQuery

oracle.toplink.essentials.queryframework.ModifyQuery

oracle.toplink.essentials.queryframework.ObjectLevelModifyQuery

oracle.toplink.essentials.queryframework.WriteObjectQuery

oracle.toplink.essentials.queryframework.DeleteObjectQuery

All Implemented Interfaces:

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

public class DeleteObjectQuery
extends WriteObjectQuery

Purpose: Used for deleting objects.

Responsibilities: Extract primary key from object and delete it.

Since:

TOPLink/Java 1.0

Author:

Yvon Lavoie

See Also:

Serialized Form

Field Summary

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

backupClone, object, objectChangeSet, primaryKey

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

forceBatchStatementExecution, modifyRow

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
DeleteObjectQuery()
DeleteObjectQuery(Call call)
DeleteObjectQuery(java.lang.Object objectToDelete)

Method Summary

Modifier and Type	Method and Description
protected DatabaseQuery	checkForCustomQuery(AbstractSession session, AbstractRecord translationRow) INTERNAL: Check to see if a custom query should be used for this query.
void	executeCommit() INTERNAL: Perform a delete.
protected java.lang.Object	executeInUnitOfWorkObjectLevelModifyQuery(UnitOfWorkImpl unitOfWork, AbstractRecord translationRow) INTERNAL: Code was moved from UnitOfWork.internalExecuteQuery
void	executeShallowWrite() INTERNAL: Perform a shallow delete.
boolean	isDeleteObjectQuery() PUBLIC: Return if this is a delete object query.
protected void	prepare() INTERNAL: Prepare the receiver for execution in a session.
protected void	prepareCustomQuery(DatabaseQuery customQuery) INTERNAL: Set the properties needed to be cascaded into the custom query.
void	prepareForExecution() INTERNAL: Prepare the receiver for execution in a session.

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

doesObjectExist, executeCommitWithChangeSet, executeDatabaseQuery, isWriteObjectQuery, shouldDependentObjectBeDeleted, shouldObjectBeDeleted

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

checkDescriptor, executeInUnitOfWork, getBackupClone, getObject, getObjectChangeSet, getPrimaryKey, getReferenceClass, getReferenceClassName, isObjectLevelModifyQuery, setBackupClone, setObject, setObjectChangeSet, setPrimaryKey, toString

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

forceBatchStatementExecution, getModifyRow, isModifyQuery, setForceBatchStatementExecution, setModifyRow

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

addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildSelectionCriteria, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkEarlyReturn, checkPrepare, clone, clonedQueryExecutionComplete, convertClassNamesToClasses, deploymentSetShouldMaintainCache, deploymentShouldMaintainCache, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, getAccessor, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getEJBQLString, getFlushOnExecute, getName, getProperties, getProperty, getQueryMechanism, getSelectionCriteria, getSession, getSessionName, getShouldBindAllParameters, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isDataModifyQuery, isDataReadQuery, isDeleteAllQuery, isExpressionQuery, isInsertObjectQuery, isModifyAllQuery, isObjectBuildingQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, maintainCache, prepareCall, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteObjectQuery

public DeleteObjectQuery()

DeleteObjectQuery

public DeleteObjectQuery(java.lang.Object objectToDelete)

DeleteObjectQuery

public DeleteObjectQuery(Call call)

Method Detail

checkForCustomQuery

protected DatabaseQuery checkForCustomQuery(AbstractSession session,
                                            AbstractRecord translationRow)

INTERNAL: Check to see if a custom query should be used for this query. This is done before the query is copied and prepared/executed. null means there is none.

Overrides:

checkForCustomQuery in class DatabaseQuery

executeCommit

public void executeCommit()
                   throws DatabaseException

INTERNAL: Perform a delete.

Overrides:

executeCommit in class WriteObjectQuery

Throws:

DatabaseException

executeInUnitOfWorkObjectLevelModifyQuery

protected java.lang.Object executeInUnitOfWorkObjectLevelModifyQuery(UnitOfWorkImpl unitOfWork,
                                                                     AbstractRecord translationRow)
                                                              throws DatabaseException,
                                                                     OptimisticLockException

INTERNAL: Code was moved from UnitOfWork.internalExecuteQuery

Overrides:

executeInUnitOfWorkObjectLevelModifyQuery in class ObjectLevelModifyQuery

Parameters:

unitOfWork -

translationRow -

Returns:

Throws:

DatabaseException

OptimisticLockException

executeShallowWrite

public void executeShallowWrite()

INTERNAL: Perform a shallow delete.

Overrides:

executeShallowWrite in class WriteObjectQuery

isDeleteObjectQuery

public boolean isDeleteObjectQuery()

PUBLIC: Return if this is a delete object query.

Overrides:

isDeleteObjectQuery in class DatabaseQuery

prepare

protected void prepare()

INTERNAL: Prepare the receiver for execution in a session.

Overrides:

prepare in class ObjectLevelModifyQuery

prepareCustomQuery

protected void prepareCustomQuery(DatabaseQuery customQuery)

INTERNAL: Set the properties needed to be cascaded into the custom query.

Overrides:

prepareCustomQuery in class DatabaseQuery

prepareForExecution

public void prepareForExecution()
                         throws QueryException

INTERNAL: Prepare the receiver for execution in a session. In particular, verify that the object is not null and contains a valid primary key.

Overrides:

prepareForExecution in class WriteObjectQuery

Throws:

QueryException