org.eclipse.persistence.queries
Class DeleteAllQuery

java.lang.Object
  org.eclipse.persistence.queries.DatabaseQuery
      org.eclipse.persistence.queries.ModifyQuery
          org.eclipse.persistence.queries.ModifyAllQuery
              org.eclipse.persistence.queries.DeleteAllQuery

All Implemented Interfaces:

Serializable, Cloneable

public class DeleteAllQuery
extends ModifyAllQuery

Purpose: Query used to delete a collection of objects

Responsibilities:

• Stores & retrieves the objects to delete.
• Store the where clause used for the deletion.

Since:

TOPLink/Java 1.0

Author:

Yvon Lavoie

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.queries.ModifyAllQuery

INVALIDATE_CACHE, NO_CACHE

Fields inherited from class org.eclipse.persistence.queries.DatabaseQuery

BATCH_FETCH_PROPERTY, CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, CascadePrivateParts, NoCascading

Constructor Summary

DeleteAllQuery()
PUBLIC:

DeleteAllQuery(Class referenceClass)
PUBLIC: Create a new delete all query for the class specified.

DeleteAllQuery(Class referenceClass, Expression selectionCriteria)
PUBLIC: Create a new delete all query for the class and the selection criteria specified.

Method Summary

Object	executeDatabaseQuery() INTERNAL: Perform the work to delete a collection of objects.
void	executeDeleteAll(org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, Vector objects) INTERNAL: Delete all queries are executed specially to avoid cloning and ensure preparing.
Object	executeInUnitOfWork(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow) INTERNAL: This method has to be broken.
Vector	getObjects() PUBLIC: Return the objects that are to be deleted
boolean	isDeleteAllQuery() PUBLIC: Return if this is a delete all query.
void	setObjects(Vector objectCollection) PUBLIC (REQUIRED): Set the objects to be deleted.

Methods inherited from class org.eclipse.persistence.queries.ModifyAllQuery

getCacheUsage, getExpressionBuilder, getReferenceClass, getReferenceClassName, isModifyQuery, isPreparedUsingTempStorage, mergeChangesIntoSharedCache, setCacheUsage, setExpressionBuilder, setIsPreparedUsingTempStorage, setReferenceClass, setReferenceClassName, setShouldDeferExecutionInUOW, shouldDeferExecutionInUOW

Methods inherited from class org.eclipse.persistence.queries.ModifyQuery

forceBatchStatementExecution, getModifyRow, setForceBatchStatementExecution, setModifyRow

Methods inherited from class org.eclipse.persistence.queries.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildArgumentFields, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkDescriptor, checkEarlyReturn, checkPrepare, checkPrepare, clone, convertClassNamesToClasses, copyFromQuery, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, extractRemoteResult, getAccessor, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getBatchObjects, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getDomainClassNounName, getDoNotRedirect, getEJBQLString, getExecutionSession, getFlushOnExecute, getHintString, getJPQLString, getName, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getRedirector, getSelectionCriteria, getSensorName, getSession, getSessionName, getShouldBindAllParameters, getSourceMapping, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasArguments, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isCustomQueryUsed, isDataModifyQuery, isDataReadQuery, isDefaultPropertiesQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isInsertObjectQuery, isJPQLCallQuery, isModifyAllQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isValueReadQuery, isWriteObjectQuery, maintainCache, prepareCall, prepareForExecution, prepareFromQuery, redirectQuery, remoteExecute, removeProperty, replaceValueHoldersIn, retrieveBypassCache, rowFromArguments, setAccessor, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setBatchObjects, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setDoNotRedirect, setEJBQLString, setFlushOnExecute, setHintString, setIsExecutionClone, setIsNativeConnectionRequired, setIsPrepared, setIsUserDefined, setJPQLString, setName, setProperties, setProperty, setQueryTimeout, setRedirector, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldRetrieveBypassCache, setShouldStoreBypassCache, setShouldUseWrapperPolicy, setSourceMapping, setSQLStatement, setSQLString, setTranslationRow, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldRetrieveBypassCache, shouldStoreBypassCache, shouldUseWrapperPolicy, storeBypassCache, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteAllQuery

public DeleteAllQuery()

PUBLIC:

DeleteAllQuery

public DeleteAllQuery(Class referenceClass)

PUBLIC: Create a new delete all query for the class specified.

DeleteAllQuery

public DeleteAllQuery(Class referenceClass,
                      Expression selectionCriteria)

PUBLIC: Create a new delete all query for the class and the selection criteria specified.

Method Detail

isDeleteAllQuery

public boolean isDeleteAllQuery()

PUBLIC: Return if this is a delete all query.

Overrides:

isDeleteAllQuery in class DatabaseQuery

executeInUnitOfWork

public Object executeInUnitOfWork(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
                                  org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)
                           throws DatabaseException,
                                  OptimisticLockException

INTERNAL: This method has to be broken. If commit manager is not active either an exception should be thrown (ObjectLevelModify case), or a transaction should be started early and execute on parent if remote (dataModify case). A modify query is NEVER executed on the parent, unless remote session.

Overrides:

executeInUnitOfWork in class ModifyAllQuery

Parameters:

unitOfWork -

translationRow -

Returns:

Throws:

org.eclipse.persistence.essentials.exceptions.DatabaseException

org.eclipse.persistence.essentials.exceptions.OptimisticLockException

DatabaseException - - an error has occurred on the database.

OptimisticLockException - - an error has occurred using the optimistic lock feature.

executeDatabaseQuery

public Object executeDatabaseQuery()
                            throws DatabaseException

INTERNAL: Perform the work to delete a collection of objects. This skips the optimistic lock check and should not called for objects using locking.

Specified by:

executeDatabaseQuery in class DatabaseQuery

Returns:

Integer the number of objects (rows) deleted.

Throws:

DatabaseException - - an error has occurred on the database.

executeDeleteAll

public void executeDeleteAll(org.eclipse.persistence.internal.sessions.AbstractSession session,
                             org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
                             Vector objects)
                      throws DatabaseException

INTERNAL: Delete all queries are executed specially to avoid cloning and ensure preparing.

Throws:

DatabaseException

getObjects

public Vector getObjects()

PUBLIC: Return the objects that are to be deleted

setObjects

public void setObjects(Vector objectCollection)

PUBLIC (REQUIRED): Set the objects to be deleted. Also REQUIRED is a selection criteria or SQL string that performs the deletion of the objects. This does not generate the SQL call from the deleted objects. #setObject() should not be called. Vector objects used as an indicator of one of two possible ways the query may behave: objects != null - the "old" functionality used by OneToMany mapping objects deleted from the cache, either selection expression or custom sql should be provided for deletion from db; objects == null - the "new" functionality (on par with UpdateAllQuery) the cache is either left alone or in-memory query finds the cached objects to be deleted, and these objects are invalidated in cache. Note that empty objects is still objects != case. Signal that no cache altering is required. Used by AggregationCollectionMapping and OneToManyMapping in case they use indirection and the ValueHolder has not been instantiated.