oracle.toplink.queryframework
Class DeleteAllQuery

java.lang.Object
  oracle.toplink.queryframework.DatabaseQuery
      oracle.toplink.queryframework.ModifyQuery
          oracle.toplink.queryframework.ModifyAllQuery
              oracle.toplink.queryframework.DeleteAllQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.helper.FalseUndefinedTrue

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

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.queryframework.ModifyAllQuery

INVALIDATE_CACHE, NO_CACHE

Fields inherited from class oracle.toplink.queryframework.DatabaseQuery

CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, CascadePrivateParts, NoCascading

Constructor Summary

DeleteAllQuery()

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

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

Method Summary

java.util.Vector	getObjects() Return the objects that are to be deleted
boolean	isDeleteAllQuery() Return if this is a delete all query.
void	setObjects(java.util.Vector objectCollection) PUBLIC (REQUIRED): Set the objects to be deleted.

Methods inherited from class oracle.toplink.queryframework.ModifyAllQuery

getCacheUsage, getExpressionBuilder, getReferenceClass, isModifyQuery, setCacheUsage, setReferenceClass, setShouldDeferExecutionInUOW, shouldDeferExecutionInUOW

Methods inherited from class oracle.toplink.queryframework.ModifyQuery

forceBatchStatementExecution, setForceBatchStatementExecution

Methods inherited from class oracle.toplink.queryframework.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, cacheStatement, cascadeAllParts, cascadeByMapping, cascadePrivateParts, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, getCall, getCalls, getDatasourceCall, getDatasourceCalls, getEJBQLString, getFlushOnExecute, getHintString, getJPQLString, getName, getQueryTimeout, getRedirector, getSelectionCriteria, getSessionName, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isDataModifyQuery, isDataReadQuery, isDeleteObjectQuery, isDirectReadQuery, isExpressionQuery, isInsertObjectQuery, isModifyAllQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isValueReadQuery, isWriteObjectQuery, maintainCache, prepareCall, setCall, setDatasourceCall, setEJBQLString, setFlushOnExecute, setHintString, setIsNativeConnectionRequired, setJPQLString, setName, setQueryTimeout, setRedirector, setSelectionCriteria, setSessionName, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeParts, shouldCascadePrivateParts, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteAllQuery

public DeleteAllQuery()

DeleteAllQuery

public DeleteAllQuery(java.lang.Class referenceClass)

Create a new delete all query for the class specified.

DeleteAllQuery

public DeleteAllQuery(java.lang.Class referenceClass,
                      Expression selectionCriteria)

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

Method Detail

isDeleteAllQuery

public boolean isDeleteAllQuery()

Return if this is a delete all query.

Overrides:

isDeleteAllQuery in class DatabaseQuery

getObjects

public java.util.Vector getObjects()

Return the objects that are to be deleted

setObjects

public void setObjects(java.util.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.