Top Description Fields Constructors Methods
org.eclipse.persistence.queries

public abstract Class ModifyQuery

extends DatabaseQuery
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.queries.ObjectLevelModifyQuery, org.eclipse.persistence.queries.DataModifyQuery, org.eclipse.persistence.queries.ModifyAllQuery
Imports
org.eclipse.persistence.internal.sessions.AbstractRecord

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

Author
Yvon Lavoie
Since
TOPLink/Java 1.0

Field Summary

Modifier and TypeField and Description
protected boolean
forceBatchStatementExecution

protected boolean
isBatchExecutionSupported

Define if this query is compatible with batch writing.

protected AbstractRecord
modifyRow

Inherited from org.eclipse.persistence.queries.DatabaseQuery:
accessorsallowNativeSQLQueryargumentFieldsargumentParameterTypesargumentsargumentTypeNamesargumentTypesargumentValuesBATCH_FETCH_PROPERTYCascadeAggregateDeleteCascadeAllPartsCascadeByMappingCascadeDependentPartscascadePolicyCascadePrivatePartsdescriptordescriptorsdoNotRedirectexecutionSessionflushOnExecutehintStringisCustomQueryUsedisExecutionCloneisNativeConnectionRequiredisPreparedisUserDefinedisUserDefinedSQLCallmonitorNamenameNoCascadingnullableArgumentsparameterDelimiterpartitioningPolicypropertiesqueryMechanismqueryTimeoutqueryTimeoutUnitredirectorsessionsessionNameshouldBindAllParametersshouldCacheStatementshouldCloneCallshouldMaintainCacheshouldPrepareshouldRetrieveBypassCacheshouldReturnGeneratedKeysshouldStoreBypassCacheshouldUseWrapperPolicyshouldValidateUpdateCallCacheUsesourceMappingtranslationRow

Constructor Summary

AccessConstructor and Description
protected
ModifyQuery()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean
forceBatchStatementExecution()

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

public AbstractRecord
getModifyRow()

INTERNAL: Return the modify row

public boolean
isBatchExecutionSupported()

PUBLIC: Return if this query is compatible with batch writing.

public boolean
isModifyQuery()

Overrides org.eclipse.persistence.queries.DatabaseQuery.isModifyQuery.

PUBLIC: Return if this is a modify query.
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.

public void
setIsBatchExecutionSupported(boolean isBatchExecutionSupported)

PUBLIC: Set if this query is compatible with batch writing.

public void
setModifyRow(AbstractRecord row)

INTERNAL: Set the modify row

Inherited from org.eclipse.persistence.queries.DatabaseQuery:
addArgumentaddArgumentaddArgumentaddArgumentaddArgumentaddArgumentaddArgumentByTypeNameaddArgumentValueaddArgumentValuesaddCalladdStatementbindAllParametersbuildArgumentFieldsbuildSelectionCriteriacacheStatementcascadeAllPartscascadeByMappingcascadeOnlyDependentPartscascadePrivatePartscheckDescriptorcheckEarlyReturncheckForCustomQuerycheckPreparecheckPreparecloneclonedQueryExecutionCompleteconvertClassNamesToClassescopyFromQuerydontBindAllParametersdontCacheStatementdontCascadePartsdontMaintainCacheexecuteexecuteDatabaseQueryexecuteInUnitOfWorkextractRemoteResultgetAccessorgetAccessorsgetArgumentParameterTypesgetArgumentsgetArgumentTypeNamesgetArgumentTypesgetArgumentValuesgetBatchObjectsgetCallgetCascadePolicygetDatasourceCallgetDatasourceCallsgetDefaultRedirectorgetDescriptorgetDescriptorsgetDomainClassNounNamegetDoNotRedirectgetEJBQLStringgetExecutionSessiongetFlushOnExecutegetHintStringgetJPQLStringgetMonitorNamegetNamegetNullableArgumentsgetParameterDelimitergetParameterDelimiterChargetPartitioningPolicygetPropertiesgetPropertygetQueryMechanismgetQueryNounNamegetQueryTimeoutgetQueryTimeoutUnitgetRedirectorgetRedirectorForQuerygetReferenceClassgetReferenceClassNamegetSelectionCriteriagetSensorNamegetSessiongetSessionNamegetShouldBindAllParametersgetSourceMappinggetSQLStatementgetSQLStringgetSQLStringsgetTranslatedSQLStringgetTranslatedSQLStringsgetTranslationRowhasAccessorhasArgumentshasNullableArgumentshasPropertieshasQueryMechanismhasSessionNameignoreBindAllParametersignoreCacheStatementisCallQueryisCascadeOfAggregateDeleteisCustomQueryUsedisCustomSelectionQueryisDataModifyQueryisDataReadQueryisDefaultPropertiesQueryisDeleteAllQueryisDeleteObjectQueryisDirectReadQueryisExecutionCloneisExpressionQueryisInsertObjectQueryisJPQLCallQueryisModifyAllQueryisNativeConnectionRequiredisObjectBuildingQueryisObjectLevelModifyQueryisObjectLevelReadQueryisPreparedisReadAllQueryisReadObjectQueryisReadQueryisReportQueryisResultSetMappingQueryisSQLCallQueryisUpdateAllQueryisUpdateObjectQueryisUserDefinedisUserDefinedSQLCallisValueReadQueryisWriteObjectQuerymaintainCacheprepareprepareCallprepareCustomQueryprepareForExecutionprepareForRemoteExecutionprepareFromQueryprepareInternalredirectQueryremoteExecuteremoteExecuteremovePropertyreplaceValueHoldersInresetMonitorNameretrieveBypassCacherowFromArgumentssetAccessorsetAccessorssetAllowNativeSQLQuerysetArgumentssetArgumentTypeNamessetArgumentTypessetArgumentValuessetBatchObjectssetCallsetCascadePolicysetDatasourceCallsetDescriptorsetDoNotRedirectsetEJBQLStringsetExecutionSessionsetFlushOnExecutesetHintStringsetIsCustomQueryUsedsetIsExecutionClonesetIsNativeConnectionRequiredsetIsPreparedsetIsUserDefinedsetIsUserDefinedSQLCallsetJPQLStringsetNamesetNullableArgumentssetParameterDelimitersetPartitioningPolicysetPropertiessetPropertysetQueryMechanismsetQueryTimeoutsetQueryTimeoutUnitsetRedirectorsetSelectionCriteriasetSessionsetSessionNamesetShouldBindAllParameterssetShouldBindAllParameterssetShouldCacheStatementsetShouldMaintainCachesetShouldPreparesetShouldRetrieveBypassCachesetShouldReturnGeneratedKeyssetShouldStoreBypassCachesetShouldUseWrapperPolicysetShouldValidateUpdateCallCacheUsesetSourceMappingsetSQLStatementsetSQLStringsetTranslationRowshouldAllowNativeSQLQueryshouldBindAllParametersshouldCacheStatementshouldCascadeAllPartsshouldCascadeByMappingshouldCascadeOnlyDependentPartsshouldCascadePartsshouldCascadePrivatePartsshouldCloneCallshouldIgnoreBindAllParametersshouldIgnoreCacheStatementshouldMaintainCacheshouldPrepareshouldPrepareshouldRetrieveBypassCacheshouldReturnGeneratedKeysshouldStoreBypassCacheshouldUseWrapperPolicyshouldValidateUpdateCallCacheUsestoreBypassCachetoString

Field Detail

forceBatchStatementExecutionback to summary
protected boolean forceBatchStatementExecution
isBatchExecutionSupportedback to summary
protected boolean isBatchExecutionSupported

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

modifyRowback to summary
protected AbstractRecord modifyRow

Constructor Detail

ModifyQueryback to summary
protected ModifyQuery()

Default constructor.

Method Detail

forceBatchStatementExecutionback to summary
public boolean forceBatchStatementExecution()

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

See Also
setForceBatchStatementExecution(boolean)
getModifyRowback to summary
public AbstractRecord getModifyRow()

INTERNAL: Return the modify row

isBatchExecutionSupportedback to summary
public boolean isBatchExecutionSupported()

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

isModifyQueryback to summary
public boolean isModifyQuery()

Overrides org.eclipse.persistence.queries.DatabaseQuery.isModifyQuery.

PUBLIC: Return if this is a modify query.

Annotations
@Override
setForceBatchStatementExecutionback to summary
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.

setIsBatchExecutionSupportedback to summary
public void setIsBatchExecutionSupported(boolean isBatchExecutionSupported)

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

setModifyRowback to summary
public void setModifyRow(AbstractRecord row)

INTERNAL: Set the modify row