jp.terasoluna.fw.batch.dao.support
インタフェース BatchUpdateSupport

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

public interface BatchUpdateSupport

バッチ更新サポートインタフェース

本クラスのメソッド実行前にsortメソッドを実行している場合、
もしくはコンストラクタや実行メソッドなどでComparatorを渡した場合は、
ソート順に並び替えられる。

関連項目:
UpdateDAO

フィールドの概要
static int ERROR_UNKNOWN_SQL_ID
          sqlIdOrderに指定されていないSQL-IDが指定されているときのエラーステータス
static int ERROR_UPDATE_DAO_IS_NULL
          UpdateDAOがnullのときのエラーステータス
 
メソッドの概要
 void addBatch(String sqlID, Object bindParams)
          バッチ実行用SQLを追加する。
 void clear()
          バッチ実行SQLリストの内容を削除する。
 int executeBatch()
          バッチ実行を行う。
 int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO)
          バッチ実行を行う。
 int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO, Comparator<String> comparator)
          バッチ実行を行う。
 int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO, String... sqlIdOrder)
          バッチ実行を行う。
 List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList()
          SQL-IDで整列されたSqlHolderリストを取得する。
 List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList(Comparator<String> comparator)
          SQL-IDで整列されたSqlHolderリストを取得する。
 List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList(String... sqlIdOrder)
          SQL-IDで整列されたSqlHolderリストを取得する。
 long size()
          バッチ実行SQLリストの登録件数を取得する。
 void sort()
          バッチ実行SQLリストのソートを行う。
 void sort(Comparator<String> comparator)
          バッチ実行SQLリストのソートを行う。
 

フィールドの詳細

ERROR_UPDATE_DAO_IS_NULL

static final int ERROR_UPDATE_DAO_IS_NULL
UpdateDAOがnullのときのエラーステータス

関連項目:
定数フィールド値

ERROR_UNKNOWN_SQL_ID

static final int ERROR_UNKNOWN_SQL_ID
sqlIdOrderに指定されていないSQL-IDが指定されているときのエラーステータス

関連項目:
定数フィールド値
メソッドの詳細

addBatch

void addBatch(String sqlID,
              Object bindParams)
バッチ実行用SQLを追加する。

パラメータ:
sqlID - String
bindParams - Object

executeBatch

int executeBatch()
バッチ実行を行う。

バッチ実行が成功した場合は、保持しているバッチ実行SQLリストの削除を行う。

本メソッドで実行する場合は、コンストラクタ引数でUpdateDAOを渡しておくこと。
UpdateDAOがコンストラクタ引数で渡されていない場合は、-100が返却される。

戻り値:
SQLの実行結果
関連項目:
UpdateDAO

executeBatch

int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO)
バッチ実行を行う。

バッチ実行が成功した場合は、保持しているバッチ実行SQLリストの削除を行う。

本メソッドで実行する場合は、コンストラクタ引数で渡されたUpdateDAOは使用されない。
UpdateDAOがnullの場合は、-100が返却される。

パラメータ:
updateDAO - UpdateDAO
戻り値:
SQLの実行結果
関連項目:
UpdateDAO

executeBatch

int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO,
                 Comparator<String> comparator)
バッチ実行を行う。

バッチ実行が成功した場合は、保持しているバッチ実行SQLリストの削除を行う。

本メソッドで実行する場合は、コンストラクタ引数で渡されたUpdateDAOは使用されない。
UpdateDAOがnullの場合は、-100が返却される。

Comparatorを渡すことによりSQL実行順序順序を制御できる。
※Comparatorを渡した場合は必ずソートが行われる。Comparatorの大小判断に基づき、昇順でソートが行われる。

パラメータ:
updateDAO - UpdateDAO
comparator - Comparator<String>
戻り値:
SQLの実行結果
関連項目:
UpdateDAO

executeBatch

int executeBatch(jp.terasoluna.fw.dao.UpdateDAO updateDAO,
                 String... sqlIdOrder)
バッチ実行を行う。

バッチ実行が成功した場合は、保持しているバッチ実行SQLリストの削除を行う。

本メソッドで実行する場合は、コンストラクタ引数で渡されたUpdateDAOは使用されない。
UpdateDAOがnullの場合は、-100が返却される。

第二引数以降に実行するSQL-IDを順番に設定することによりSQL実行順序を制御できる。
sqlIdOrderにSQL-IDを指定した場合は、必ずその順番でSQLが実行される。
また、その際はsqlIdOrderに指定されていないSQL-IDが存在した場合は実行されずに-200が返却される。

パラメータ:
updateDAO - UpdateDAO
sqlIdOrder - SQL-IDの実行順序を指定する
戻り値:
SQLの実行結果
関連項目:
UpdateDAO

sort

void sort()
バッチ実行SQLリストのソートを行う。

executeBatchやgetSqlHolderListを実行する前に本メソッドを実行することで、
SQLの実行順序をSQL-IDの昇順に並び替えることができる。

※本メソッド実行タイミングで実際に内部でソートが行われるかどうかは規定しない


sort

void sort(Comparator<String> comparator)
バッチ実行SQLリストのソートを行う。

executeBatchやgetSqlHolderListを実行する前に本メソッドを実行することで、
SQLの実行順序をComparatorに従って並び替えることができる。

Comparatorを渡すことによりSQLの並び替え順序を制御できる。
(※Comparatorを渡した場合は必ずソートが行われる。Comparatorの大小判断に基づき、昇順でソートが行われる。)

※本メソッド実行タイミングで実際に内部でソートが行われるかどうかは規定しない

パラメータ:
comparator - Comparator<String>

clear

void clear()
バッチ実行SQLリストの内容を削除する。

保持しているバッチ実行SQLリストの削除を行う。


size

long size()
バッチ実行SQLリストの登録件数を取得する。

戻り値:
バッチ実行SQLリストの登録件数

getSqlHolderList

List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList()
SQL-IDで整列されたSqlHolderリストを取得する。

保持しているバッチ実行SQLリストをSQL-ID順に整列したリストを返却する。

※本メソッドを実行しても保持しているバッチ実行SQLリストは削除されない。

戻り値:
SqlHolderリスト

getSqlHolderList

List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList(Comparator<String> comparator)
SQL-IDで整列されたSqlHolderリストを取得する。

保持しているバッチ実行SQLリストをSQL-ID順に整列したリストを返却する。

※本メソッドを実行しても保持しているバッチ実行SQLリストは削除されない。

Comparatorを渡すことによりSQLの並び替え順序を制御できる。
※Comparatorを渡した場合は必ずソートが行われる。Comparatorの大小判断に基づき、昇順でソートが行われる。

パラメータ:
comparator - Comparator<String>
戻り値:
SqlHolderリスト

getSqlHolderList

List<jp.terasoluna.fw.dao.SqlHolder> getSqlHolderList(String... sqlIdOrder)
SQL-IDで整列されたSqlHolderリストを取得する。

保持しているバッチ実行SQLリストをSQL-ID順に整列したリストを返却する。

※本メソッドを実行しても保持しているバッチ実行SQLリストは削除されない。

実行するSQL-IDを順番に設定することにより取得すSqlHolderリストの順序を制御できる。
sqlIdOrderにSQL-IDを指定した場合は、必ずその順番でSQLが並び替えられる。
また、その際はsqlIdOrderに指定されていないSQL-IDが存在した場合はnullが返却される。

パラメータ:
sqlIdOrder - SQL-IDの実行順序を指定する
戻り値:
SqlHolderリスト


Copyright © 2011. All Rights Reserved.