Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Class SqlProcessorQuery

java.lang.Object

org.seasar.doma.jdbc.query.AbstractQuery

org.seasar.doma.jdbc.query.SqlProcessorQuery

All Implemented Interfaces:

Query

public class SqlProcessorQuery
extends AbstractQuery

A query that processes SQL files. This class is responsible for loading SQL files and building prepared SQL statements with parameter binding.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Value>	parameters	The parameters to be bound to the SQL.
protected PreparedSql	sql	The prepared SQL statement.
protected SqlFile	sqlFile	The SQL file.
protected String	sqlFilePath	The path to the SQL file.

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

callerClassName, callerMethodName, config, message, method, queryTimeout

Constructor Summary

Constructors

Constructor	Description
SqlProcessorQuery()

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, Class<?> type, Object value)	Adds a parameter to be bound to the SQL.
void	complete()	Completes this query.
PreparedSql	getSql()	Returns the prepared SQL statement.
void	prepare()	Prepares this query for execution.
protected void	prepareSql()	Prepares the SQL statement by loading the SQL file and building the prepared SQL.
void	setSqlFilePath(String sqlFilePath)	Sets the path to the SQL file.

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, toString, wait, wait, wait

Field Details

parameters

protected final Map<String,Value> parameters

The parameters to be bound to the SQL.

sqlFilePath

protected String sqlFilePath

The path to the SQL file.

sqlFile

protected SqlFile sqlFile

The SQL file.

sql

protected PreparedSql sql

The prepared SQL statement.

Constructor Details

SqlProcessorQuery

public SqlProcessorQuery()

Method Details

setSqlFilePath

public void setSqlFilePath(String sqlFilePath)

Sets the path to the SQL file.

Parameters:

sqlFilePath - the SQL file path

addParameter

public void addParameter(String name,
 Class<?> type,
 Object value)

Adds a parameter to be bound to the SQL.

Parameters:

name - the parameter name

type - the parameter type

value - the parameter value

prepare

public void prepare()

Prepares this query for execution. This method must be called before getSql().

Specified by:

prepare in interface Query

Overrides:

prepare in class AbstractQuery

prepareSql

protected void prepareSql()

Prepares the SQL statement by loading the SQL file and building the prepared SQL.

getSql

public PreparedSql getSql()

Returns the prepared SQL statement.

Returns:

the prepared SQL statement

complete

public void complete()

Completes this query. This method is called after the query execution.