org.seasar.extension.sql
インタフェース SqlContext

既知の実装クラスの一覧:

SqlContextImpl

public interface SqlContext

ｊSQLを実行するときのコンテキストです。 コンテキストでSQLを実行するのに必要な情報を組み立てた後、 getSql(), getBindVariables(), getBindVariableTypes()で、 情報を取り出してSQLを実行します。 SQLでBEGINコメントとENDコメントで囲まれている部分が、 子供のコンテキストになります。 通常は、 WHERE句をBEGINコメントとENDコメントで囲み、 WHERE句の中のIFコメントが1つでも成立した場合、enabledになります。

作成者:

higa

メソッドの概要

void	addArg(String name, Object arg, Class argType) 引数を追加します。
void	addCompleteSql(String sql) バインド変数が埋め込まれたSQLを追加します。
SqlContext	addSql(String sql) SQLを追加します。
SqlContext	addSql(String sql, Object[] bindVariables, Class[] bindVariableTypes) SQLとバインド変数の配列を追加します。
SqlContext	addSql(String sql, Object bindVariable, Class bindVariableType) SQLとバインド変数を追加します。
Object	getArg(String name) 名前に応じた引数を返します。
Class	getArgType(String name) 名前に応じた引数のクラスを返します。
Object[]	getBindVariables() 追加されたすべてのバインド変数の配列を返します。
Class[]	getBindVariableTypes() 追加されたすべてのバインド変数の型の配列を返します。
String	getCompleteSql() バインド変数が埋め込まれたSQLを返します。
String	getSql() 追加されたすべてのSQLを返します。
boolean	hasArg(String name) 引数が存在するかどうかを返します。
boolean	isEnabled() BEGINコメントとENDコメントで、 囲まれた子供のコンテキストが有効かどうかを返します。
void	setEnabled(boolean enabled) BEGINコメントとENDコメントで、 囲まれた子供のコンテキストが有効かどうかを設定します。

メソッドの詳細

getArg

public Object getArg(String name)

名前に応じた引数を返します。

パラメータ:

name - 引数名

戻り値:

名前に応じた引数

hasArg

public boolean hasArg(String name)

引数が存在するかどうかを返します。

パラメータ:

name - 引数名

戻り値:

引数が存在するか

getArgType

public Class getArgType(String name)

名前に応じた引数のクラスを返します。 getArg()がnullを返す場合があるので、 このメソッドが用意されています。

パラメータ:

name - 引数名

戻り値:

名前に応じた引数のクラスを返します。

addArg

public void addArg(String name,
                   Object arg,
                   Class argType)

引数を追加します。

パラメータ:

name - 引数名

arg - 引数

argType - 引数の型

getSql

public String getSql()

追加されたすべてのSQLを返します。

戻り値:

SQL

getCompleteSql

public String getCompleteSql()

バインド変数が埋め込まれたSQLを返します。

戻り値:

addCompleteSql

public void addCompleteSql(String sql)

バインド変数が埋め込まれたSQLを追加します。

パラメータ:

sql -

getBindVariables

public Object[] getBindVariables()

追加されたすべてのバインド変数の配列を返します。

戻り値:

バインド変数の配列

getBindVariableTypes

public Class[] getBindVariableTypes()

追加されたすべてのバインド変数の型の配列を返します。

戻り値:

バインド変数の型の配列

addSql

public SqlContext addSql(String sql)

SQLを追加します。

パラメータ:

sql -

戻り値:

コンテキスト自身

addSql

public SqlContext addSql(String sql,
                         Object bindVariable,
                         Class bindVariableType)

SQLとバインド変数を追加します。

パラメータ:

sql -

bindVariable -

bindVariableType -

戻り値:

addSql

public SqlContext addSql(String sql,
                         Object[] bindVariables,
                         Class[] bindVariableTypes)

SQLとバインド変数の配列を追加します。

パラメータ:

sql -

bindVariables -

bindVariableTypes -

戻り値:

isEnabled

public boolean isEnabled()

BEGINコメントとENDコメントで、 囲まれた子供のコンテキストが有効かどうかを返します。

戻り値:

有効かどうか

setEnabled

public void setEnabled(boolean enabled)

BEGINコメントとENDコメントで、 囲まれた子供のコンテキストが有効かどうかを設定します。

パラメータ:

enabled - 有効かどうか