Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Class SqlFileInsertQuery

java.lang.Object

org.seasar.doma.jdbc.query.AbstractQuery

org.seasar.doma.jdbc.query.SqlFileModifyQuery

org.seasar.doma.jdbc.query.SqlFileInsertQuery

All Implemented Interfaces:

InsertQuery, ModifyQuery, Query

public class SqlFileInsertQuery
extends SqlFileModifyQuery
implements InsertQuery

A query that inserts data into a database using an external SQL file.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SqlFileInsertQuery.EntityHandler<E>	A handler for entity lifecycle callbacks.
protected static class	SqlFileInsertQuery.SqlFilePostInsertContext<E>	A context for post-insert entity lifecycle callbacks.
protected static class	SqlFileInsertQuery.SqlFilePreInsertContext<E>	A context for pre-insert entity lifecycle callbacks.

Field Summary

Fields

Modifier and Type	Field	Description
protected SqlFileInsertQuery.EntityHandler<?>	entityHandler	The entity handler for this query.
protected boolean	nullExcluded	Whether to exclude null properties from the insert operation.

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
SqlFileInsertQuery()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	complete()	Completes this query after execution.
void	generateId(Statement statement)	Generates an ID for the inserted row.
<E> E	getEntity(Class<E> entityType)	Returns the entity associated with this query.
protected void	preInsert()	Executes pre-insert entity lifecycle callbacks.
void	prepare()	Prepares this query for execution.
protected void	prepareExecutable()	Prepares the executable state for this query.
<E> void	setEntityAndEntityType(String name, E entity, EntityType<E> entityType)	Sets the entity and entity type for this query.
void	setNullExcluded(boolean nullExcluded)	Sets whether to exclude null properties from the insert operation.

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

nullExcluded

protected boolean nullExcluded

Whether to exclude null properties from the insert operation.

entityHandler

protected SqlFileInsertQuery.EntityHandler<?> entityHandler

The entity handler for this query.

Constructor Details

SqlFileInsertQuery

public SqlFileInsertQuery()

Constructs a new instance.

This constructor initializes the query with SqlKind.INSERT to indicate that it performs an INSERT 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.

Specified by:

prepare in interface Query

Overrides:

prepare in class AbstractQuery

preInsert

protected void preInsert()

Executes pre-insert entity lifecycle callbacks.

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.

generateId

public void generateId(Statement statement)

Generates an ID for the inserted row.

This method is called after executing the INSERT statement to retrieve and set auto-generated keys or sequence values for the entity. It's typically used for primary key generation strategies like identity columns or sequences.

This implementation does nothing because this query does not support auto-generated keys.

Specified by:

generateId in interface InsertQuery

Parameters:

statement - the statement used for the INSERT operation

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

complete

public void complete()

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

This implementation executes post-insert 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

setNullExcluded

public void setNullExcluded(boolean nullExcluded)

Sets whether to exclude null properties from the insert operation.

Parameters:

nullExcluded - whether to exclude null properties