Module org.eclipse.persistence.core

Package org.eclipse.persistence.queries

Class ModifyQuery

java.lang.Object

org.eclipse.persistence.queries.DatabaseQuery

org.eclipse.persistence.queries.ModifyQuery

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DataModifyQuery, ModifyAllQuery, ObjectLevelModifyQuery

public abstract class ModifyQuery
extends DatabaseQuery

Purpose: Abstract class for all modify queries. Currently contains no behavior.

Since:

TOPLink/Java 1.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.queries.DatabaseQuery

DatabaseQuery.ParameterType

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	forceBatchStatementExecution
protected boolean	isBatchExecutionSupported	Define if this query is compatible with batch writing.
protected AbstractRecord	modifyRow

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

accessors, allowNativeSQLQuery, argumentFields, argumentParameterTypes, arguments, argumentTypeNames, argumentTypes, argumentValues, BATCH_FETCH_PROPERTY, CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, cascadePolicy, CascadePrivateParts, descriptor, descriptors, doNotRedirect, executionSession, flushOnExecute, hintString, isCustomQueryUsed, isExecutionClone, isNativeConnectionRequired, isPrepared, isUserDefined, isUserDefinedSQLCall, monitorName, name, NoCascading, nullableArguments, parameterDelimiter, partitioningPolicy, properties, queryMechanism, queryTimeout, queryTimeoutUnit, redirector, session, sessionName, shouldBindAllParameters, shouldCacheStatement, shouldCloneCall, shouldMaintainCache, shouldPrepare, shouldRetrieveBypassCache, shouldReturnGeneratedKeys, shouldStoreBypassCache, shouldUseWrapperPolicy, shouldValidateUpdateCallCacheUse, sourceMapping, translationRow

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModifyQuery()	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	forceBatchStatementExecution()	PUBLIC: Returns if this query has been set to flush on execution.
AbstractRecord	getModifyRow()	INTERNAL: Return the modify row
boolean	isBatchExecutionSupported()	PUBLIC: Return if this query is compatible with batch writing.
boolean	isModifyQuery()	PUBLIC: Return if this is a modify query.
void	setForceBatchStatementExecution(boolean value)	PUBLIC: Allow setting this query to be the last statement added to a batch statement and ensure it is flushed on execution.
void	setIsBatchExecutionSupported(boolean isBatchExecutionSupported)	PUBLIC: Set if this query is compatible with batch writing.
void	setModifyRow(AbstractRecord row)	INTERNAL: Set the modify row

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

addArgument, addArgument, addArgument, addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildArgumentFields, buildSelectionCriteria, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkDescriptor, checkEarlyReturn, checkForCustomQuery, checkPrepare, checkPrepare, clone, clonedQueryExecutionComplete, convertClassNamesToClasses, copyFromQuery, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, executeDatabaseQuery, executeInUnitOfWork, extractRemoteResult, getAccessor, getAccessors, getArgumentParameterTypes, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getBatchObjects, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDefaultRedirector, getDescriptor, getDescriptors, getDomainClassNounName, getDoNotRedirect, getEJBQLString, getExecutionSession, getFlushOnExecute, getHintString, getJPQLString, getMonitorName, getName, getNullableArguments, getParameterDelimiter, getParameterDelimiterChar, getPartitioningPolicy, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getQueryTimeoutUnit, getRedirector, getRedirectorForQuery, getReferenceClass, getReferenceClassName, getSelectionCriteria, getSensorName, getSession, getSessionName, getShouldBindAllParameters, getSourceMapping, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasArguments, hasNullableArguments, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isCustomQueryUsed, isCustomSelectionQuery, isDataModifyQuery, isDataReadQuery, isDefaultPropertiesQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isInsertObjectQuery, isJPQLCallQuery, isModifyAllQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isResultSetMappingQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isUserDefined, isUserDefinedSQLCall, isValueReadQuery, isWriteObjectQuery, maintainCache, prepare, prepareCall, prepareCustomQuery, prepareForExecution, prepareForRemoteExecution, prepareFromQuery, prepareInternal, redirectQuery, remoteExecute, remoteExecute, removeProperty, replaceValueHoldersIn, resetMonitorName, retrieveBypassCache, rowFromArguments, setAccessor, setAccessors, setAllowNativeSQLQuery, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setBatchObjects, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setDoNotRedirect, setEJBQLString, setExecutionSession, setFlushOnExecute, setHintString, setIsCustomQueryUsed, setIsExecutionClone, setIsNativeConnectionRequired, setIsPrepared, setIsUserDefined, setIsUserDefinedSQLCall, setJPQLString, setName, setNullableArguments, setParameterDelimiter, setPartitioningPolicy, setProperties, setProperty, setQueryMechanism, setQueryTimeout, setQueryTimeoutUnit, setRedirector, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldRetrieveBypassCache, setShouldReturnGeneratedKeys, setShouldStoreBypassCache, setShouldUseWrapperPolicy, setShouldValidateUpdateCallCacheUse, setSourceMapping, setSQLStatement, setSQLString, setTranslationRow, shouldAllowNativeSQLQuery, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldPrepare, shouldRetrieveBypassCache, shouldReturnGeneratedKeys, shouldStoreBypassCache, shouldUseWrapperPolicy, shouldValidateUpdateCallCacheUse, storeBypassCache, toString

Methods inherited from class java.lang.Object

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

Field Details

modifyRow

protected AbstractRecord modifyRow

forceBatchStatementExecution

protected boolean forceBatchStatementExecution

isBatchExecutionSupported

protected boolean isBatchExecutionSupported

Define if this query is compatible with batch writing. Some queries, such as DDL are not compatible.

Constructor Details

ModifyQuery

protected ModifyQuery()

Default constructor.

Method Details

getModifyRow

public AbstractRecord getModifyRow()

INTERNAL: Return the modify row

isModifyQuery

public boolean isModifyQuery()

PUBLIC: Return if this is a modify query.

Overrides:

isModifyQuery in class DatabaseQuery

setModifyRow

public void setModifyRow(AbstractRecord row)

INTERNAL: Set the modify row

setForceBatchStatementExecution

public void setForceBatchStatementExecution(boolean value)

PUBLIC: Allow setting this query to be the last statement added to a batch statement and ensure it is flushed on execution. Setting to true will cause the batch statement to be sent to the database. Default setting of false causes the batch statement execution to be delayed to allow additional statements to be added. Setting to true reduces the efficiency of batch writing. This has no effect if batch writing is not enabled.

forceBatchStatementExecution

public boolean forceBatchStatementExecution()

PUBLIC: Returns if this query has been set to flush on execution.

See Also:

• setForceBatchStatementExecution(boolean)

isBatchExecutionSupported

public boolean isBatchExecutionSupported()

PUBLIC: Return if this query is compatible with batch writing. Some queries, such as DDL are not compatible.

setIsBatchExecutionSupported

public void setIsBatchExecutionSupported(boolean isBatchExecutionSupported)

PUBLIC: Set if this query is compatible with batch writing. Some queries, such as DDL are not compatible.