Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Class SqlFileDeleteQuery

java.lang.Object

org.seasar.doma.jdbc.query.AbstractQuery

org.seasar.doma.jdbc.query.SqlFileModifyQuery

org.seasar.doma.jdbc.query.SqlFileDeleteQuery

All Implemented Interfaces:

DeleteQuery, ModifyQuery, Query

public class SqlFileDeleteQuery
extends SqlFileModifyQuery
implements DeleteQuery

A query that deletes data from a database using an external SQL file.

This class extends SqlFileModifyQuery to provide functionality for executing DELETE statements defined in external SQL files. It handles entity lifecycle callbacks, optimistic locking, and SQL file execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SqlFileDeleteQuery.EntityHandler<E>	A handler for entity lifecycle callbacks and optimistic locking.
protected static class	SqlFileDeleteQuery.SqlFilePostDeleteContext<E>	A context for post-delete entity lifecycle callbacks.
protected static class	SqlFileDeleteQuery.SqlFilePreDeleteContext<E>	A context for pre-delete entity lifecycle callbacks.

Field Summary

Fields

Modifier and Type	Field	Description
protected SqlFileDeleteQuery.EntityHandler<?>	entityHandler	The entity handler for this query.
protected boolean	optimisticLockExceptionSuppressed	Whether to suppress optimistic lock exceptions.
protected boolean	versionIgnored	Whether to ignore the version property for optimistic locking.

Fields inherited from class org.seasar.doma.jdbc.query.SqlFileModifyQuery

EMPTY_STRINGS, excludedPropertyNames, executable, includedPropertyNames, kind, optimisticLockCheckRequired, parameters, sql, sqlExecutionSkipCause, sqlFilePath, sqlLogType

Fields inherited from class org.seasar.doma.jdbc.query.AbstractQuery

callerClassName, callerMethodName, config, message, method, queryTimeout

Constructor Summary

Constructors

Constructor	Description
SqlFileDeleteQuery()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	complete()	Completes this query after execution.
<E> E	getEntity(Class<E> entityType)	Returns the entity associated with this query.
protected void	preDelete()	Executes pre-delete entity lifecycle callbacks.
void	prepare()	Prepares this query for execution.
protected void	prepareExecutable()	Prepares the executable state for this query.
protected void	prepareOptimisticLock()	Prepares optimistic locking for this query.
<E> void	setEntityAndEntityType(String name, E entity, EntityType<E> entityType)	Sets the entity and entity type for this query.
void	setOptimisticLockExceptionSuppressed(boolean optimisticLockExceptionSuppressed)	Sets whether to suppress optimistic lock exceptions.
void	setVersionIgnored(boolean versionIgnored)	Sets whether to ignore the version property for optimistic locking.

Methods inherited from class org.seasar.doma.jdbc.query.SqlFileModifyQuery

addParameter, addParameterInternal, expandColumns, getSql, getSqlExecutionSkipCause, getSqlLogType, isAutoGeneratedKeysSupported, isExecutable, isOptimisticLockCheckRequired, populateValues, prepareOptions, prepareSql, setExcludedPropertyNames, setIncludedPropertyNames, setSqlFilePath, setSqlLogType, toString

Methods inherited from class org.seasar.doma.jdbc.query.AbstractQuery

comment, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout, setCallerClassName, setCallerMethodName, setConfig, setMessage, setMethod, setQueryTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.seasar.doma.jdbc.query.ModifyQuery

getSql, getSqlExecutionSkipCause, getSqlLogType, isAutoGeneratedKeysSupported, isExecutable, isOptimisticLockCheckRequired

Methods inherited from interface org.seasar.doma.jdbc.query.Query

comment, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout

Field Details

entityHandler

protected SqlFileDeleteQuery.EntityHandler<?> entityHandler

The entity handler for this query.

versionIgnored

protected boolean versionIgnored

Whether to ignore the version property for optimistic locking.

optimisticLockExceptionSuppressed

protected boolean optimisticLockExceptionSuppressed

Whether to suppress optimistic lock exceptions.

Constructor Details

SqlFileDeleteQuery

public SqlFileDeleteQuery()

Constructs a new instance.

This constructor initializes the query with SqlKind.DELETE to indicate that it performs a DELETE operation.

Method Details

prepare

public void prepare()

Prepares this query for execution. This method must be called before the query is executed.

This implementation prepares the SQL statement by processing the SQL file and handling entity lifecycle callbacks and optimistic locking.

Specified by:

prepare in interface Query

Overrides:

prepare in class AbstractQuery

preDelete

protected void preDelete()

Executes pre-delete entity lifecycle callbacks.

This method delegates to the entity handler if one is available.

prepareOptimisticLock

protected void prepareOptimisticLock()

Prepares optimistic locking for this query.

This method delegates to the entity handler if one is available.

prepareExecutable

protected void prepareExecutable()

Prepares the executable state for this query.

This method sets the query as executable and clears any skip cause.

complete

public void complete()

Completes this query after execution. This method must be called after the query is executed.

This implementation executes post-delete entity lifecycle callbacks.

Specified by:

complete in interface Query

setEntityAndEntityType

public <E> void setEntityAndEntityType(String name,
 E entity,
 EntityType<E> entityType)

Sets the entity and entity type for this query.

This implementation creates an entity handler for the specified entity.

Specified by:

setEntityAndEntityType in class SqlFileModifyQuery

Type Parameters:

E - the entity type

Parameters:

name - the parameter name for the entity

entity - the entity

entityType - the entity type

setVersionIgnored

public void setVersionIgnored(boolean versionIgnored)

Sets whether to ignore the version property for optimistic locking.

Parameters:

versionIgnored - whether to ignore the version property

setOptimisticLockExceptionSuppressed

public void setOptimisticLockExceptionSuppressed(boolean optimisticLockExceptionSuppressed)

Sets whether to suppress optimistic lock exceptions.

Parameters:

optimisticLockExceptionSuppressed - whether to suppress optimistic lock exceptions

getEntity

public <E> E getEntity(Class<E> entityType)

Returns the entity associated with this query.

Type Parameters:

E - the entity type

Parameters:

entityType - the entity class

Returns:

the entity, or null if no entity is associated with this query