nga.sql
クラス XSQL

java.lang.Object
  nga.sql.XSQL

public class XSQL
extends Object

XML による定義ファイルを使った SQL オブジェクト作成用ファクトリクラス。

メソッドの概要

static int	call(String sqlId) 指定した SQL 文を実行する。
static int	call(String sqlId, Object parameterObject) 指定した SQL 文を実行する。
static Caller	createCaller(Connection connection, String sqlId) ストアドプロシージャ / ストアドファンクション用 SQL オブジェクトを作成する。
static Caller	createCaller(String sqlId) ストアドプロシージャ / ストアドファンクション用 SQL オブジェクトを作成する。
static <R> Selecter<R>	createSelecter(Connection connection, String sqlId) Select 文用 SQL オブジェクトを作成する。
static <R> Selecter<R>	createSelecter(Connection connection, String sqlId, Object parameterObject) Select 文用 SQL オブジェクトを作成する。
static <R> Selecter<R>	createSelecter(String sqlId) Select 文用 SQL オブジェクトを作成する。
static <R> Selecter<R>	createSelecter(String sqlId, Object parameterObject) Select 文用 SQL オブジェクトを作成する。
static Updater	createUpdater(Connection connection, String sqlId) Update / Insert / Delete 文用 SQL オブジェクトを作成する。
static Updater	createUpdater(String sqlId) Update / Insert / Delete 文用 SQL オブジェクトを作成する。
static int	execute(String sqlId) 指定した SQL 文を実行する。
static int[]	execute(String sqlId, List parameterObjectList) 指定した SQL 文を一括実行する。
static int	execute(String sqlId, Object parameterObject) 指定した SQL 文を実行する。
static <R> List<R>	find(String sqlId) SELECT 文を実行し，指定されたクラスのインスタンスをリストに格納して返す。
static <R> List<R>	find(String sqlId, List<R> list) SELECT 文を実行し，指定されたリストに格納して返す。
static <R> List<R>	find(String sqlId, Object parameterObject) SELECT 文を実行し，指定されたクラスのインスタンスをリストに格納して返す。
static <R> List<R>	find(String sqlId, Object parameterObject, List<R> list) SELECT 文を実行し，指定されたリストに格納して返す。
static <R> R	find(String sqlId, Object parameterObject, R object) SELECT 文を実行し，指定されたオブジェクトに格納して返す。
static int	getDefaultBatchSize() デフォルト一括実行数を取得する。
static int	getDefaultMaxRows() 検索結果の最大行数を取得する。
static int	getDefaultQueryTimeout() クエリーのタイムアウト時間（秒）を取得する。
static void	setDefaultBatchSize(int size) デフォルト一括実行数をセットする。
static void	setDefaultMaxRows(int maxRows) 検索結果の最大行数をセットする。
static void	setDefaultQueryTimeout(int queryTimeout) クエリーのタイムアウト時間（秒）をセットする。

クラス java.lang.Object から継承されたメソッド

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

メソッドの詳細

createSelecter

public static <R> Selecter<R> createSelecter(Connection connection,
                                             String sqlId)

Select 文用 SQL オブジェクトを作成する。

パラメータ:

connection - データベースコネクション。

sqlId - SQL定義ID。

戻り値:

Select 文用 SQL オブジェクト。

createSelecter

public static <R> Selecter<R> createSelecter(Connection connection,
                                             String sqlId,
                                             Object parameterObject)

Select 文用 SQL オブジェクトを作成する。

パラメータ:

connection - データベースコネクション。

sqlId - SQL定義ID。

parameterObject - パラメタオブジェクト。

戻り値:

Select 文用 SQL オブジェクト。

createUpdater

public static Updater createUpdater(Connection connection,
                                    String sqlId)

Update / Insert / Delete 文用 SQL オブジェクトを作成する。

パラメータ:

connection - データベースコネクション。

sqlId - SQL定義ID。

戻り値:

Update / Insert / Delete 文用 SQL オブジェクト。

createCaller

public static Caller createCaller(Connection connection,
                                  String sqlId)

ストアドプロシージャ / ストアドファンクション用 SQL オブジェクトを作成する。

パラメータ:

connection - データベースコネクション。

sqlId - SQL定義ID。

戻り値:

ストアドプロシージャ / ストアドファンクション用 SQL オブジェクト。

createSelecter

public static <R> Selecter<R> createSelecter(String sqlId)

Select 文用 SQL オブジェクトを作成する。

パラメータ:

sqlId - SQL定義ID。

戻り値:

Select 文用 SQL オブジェクト。

createSelecter

public static <R> Selecter<R> createSelecter(String sqlId,
                                             Object parameterObject)

Select 文用 SQL オブジェクトを作成する。

パラメータ:

sqlId - SQL定義ID。

parameterObject - パラメタオブジェクト。

戻り値:

Select 文用 SQL オブジェクト。

createUpdater

public static Updater createUpdater(String sqlId)

Update / Insert / Delete 文用 SQL オブジェクトを作成する。

パラメータ:

sqlId - SQL定義ID。

戻り値:

Update / Insert / Delete 文用 SQL オブジェクト。

createCaller

public static Caller createCaller(String sqlId)

ストアドプロシージャ / ストアドファンクション用 SQL オブジェクトを作成する。

パラメータ:

sqlId - SQL定義ID。

戻り値:

ストアドプロシージャ / ストアドファンクション用 SQL オブジェクト。

find

public static <R> List<R> find(String sqlId)
                    throws SQLException

SELECT 文を実行し，指定されたクラスのインスタンスをリストに格納して返す。

戻り値:

SQL実行結果を格納したリスト。検索結果が 0 件の場合は，要素数 0 のリストとなる。

例外:

SQLException

find

public static <R> List<R> find(String sqlId,
                               Object parameterObject)
                    throws SQLException

SELECT 文を実行し，指定されたクラスのインスタンスをリストに格納して返す。

戻り値:

SQL実行結果を格納したリスト。検索結果が 0 件の場合は，要素数 0 のリストとなる。

例外:

SQLException

find

public static <R> List<R> find(String sqlId,
                               List<R> list)
                    throws SQLException

SELECT 文を実行し，指定されたリストに格納して返す。

パラメータ:

list - 検索結果の格納先リスト。

戻り値:

引数 list と同一のインスタンス。

例外:

SQLException

find

public static <R> List<R> find(String sqlId,
                               Object parameterObject,
                               List<R> list)
                    throws SQLException

SELECT 文を実行し，指定されたリストに格納して返す。

パラメータ:

list - 検索結果の格納先リスト。

戻り値:

引数 list と同一のインスタンス。

例外:

SQLException

find

public static <R> R find(String sqlId,
                         Object parameterObject,
                         R object)
              throws SQLException

SELECT 文を実行し，指定されたオブジェクトに格納して返す。 検索結果が 2 件以上あった場合は，1 件目のみ指定されたオブジェクトに格納する。

戻り値:

引数 object と同一のインスタンス。但し，検索結果が 0 件の場合は，null。

例外:

SQLException

execute

public static int execute(String sqlId)
                   throws DuplicatedException,
                          SQLException

指定した SQL 文を実行する。

戻り値:

SQL実行結果件数。

例外:

DuplicatedException - 重複エラーが発生した場合。

SQLException

execute

public static int execute(String sqlId,
                          Object parameterObject)
                   throws DuplicatedException,
                          SQLException

指定した SQL 文を実行する。

パラメータ:

parameterObject - SQLに埋め込む値を格納しているパラメタオブジェクト。

戻り値:

SQL実行結果件数。

例外:

DuplicatedException - 重複エラーが発生した場合。

SQLException

execute

public static int[] execute(String sqlId,
                            List parameterObjectList)
                     throws DuplicatedException,
                            SQLException

指定した SQL 文を一括実行する。
指定されたパラメタオブジェクトの件数分 PreparedStatement.executeUpdate() を実行する。

パラメータ:

parameterObjectList - SQLに埋め込む値を格納しているパラメタオブジェクトのリスト。

戻り値:

SQL実行結果件数。

例外:

DuplicatedException - 重複エラーが発生した場合。

SQLException

call

public static int call(String sqlId)
                throws DuplicatedException,
                       SQLException

指定した SQL 文を実行する。

戻り値:

SQL実行結果件数。

例外:

DuplicatedException - 重複エラーが発生した場合。

SQLException

call

public static int call(String sqlId,
                       Object parameterObject)
                throws DuplicatedException,
                       SQLException

指定した SQL 文を実行する。

パラメータ:

parameterObject - SQLに埋め込む値を格納しているパラメタオブジェクト。

戻り値:

SQL実行結果件数。

例外:

DuplicatedException - 重複エラーが発生した場合。

SQLException

getDefaultQueryTimeout

public static int getDefaultQueryTimeout()

クエリーのタイムアウト時間（秒）を取得する。

戻り値:

クエリーのタイムアウト時間（秒）。

setDefaultQueryTimeout

public static void setDefaultQueryTimeout(int queryTimeout)

クエリーのタイムアウト時間（秒）をセットする。

パラメータ:

queryTimeout - クエリーのタイムアウト時間（秒）。

getDefaultMaxRows

public static int getDefaultMaxRows()

検索結果の最大行数を取得する。

戻り値:

検索結果の最大行数。

setDefaultMaxRows

public static void setDefaultMaxRows(int maxRows)

検索結果の最大行数をセットする。

パラメータ:

maxRows - 検索結果の最大行数。

getDefaultBatchSize

public static int getDefaultBatchSize()

デフォルト一括実行数を取得する。

戻り値:

一括実行数。

setDefaultBatchSize

public static void setDefaultBatchSize(int size)

デフォルト一括実行数をセットする。

パラメータ:

size - 一括実行数。