nablarch.core.db.statement

クラス BasicSqlLoader

java.lang.Object

nablarch.core.db.statement.BasicSqlLoader

すべての実装されたインタフェース:

StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

public class BasicSqlLoader
extends java.lang.Object
implements StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

SQL文をクラスパス上のリソース(SQLファイル)からロードするクラス。

本クラスでは、下記ルールに従いSQL文をロードする。

a) SQL_IDとSQL文の1グループは、空行で区切られて記述されている。

1つのSQL文の中に空行はいれてはならない。 また、異なるSQL文との間には必ず空行を入れなくてはならない。 コメント行は、空行とはならない。

b) 1つのSQL文の最初の「=」までがSQL_IDとなる。

SQL_IDとは、SQLファイル内でSQL文を一意に特定するためのIDである。 SQL_IDには、任意の値を設定することが可能となっている。

c) コメントは、「--」で開始されている必要がある。

「--」以降の値は、コメントとして扱い読み込まない。
※コメントは、行コメントとして扱う。複数行に跨るブロックコメントはサポートしない。

d) SQL文の途中で改行を行っても良い。また、可読性を考慮してスペースやtabなどで桁揃えを行っても良い。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
BasicSqlLoader()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	generateIndexKey(java.lang.String indexName, java.util.Map<java.lang.String,java.lang.String> value) 静的データからインデックスのキーを生成する。
java.lang.Object	getId(java.util.Map<java.lang.String,java.lang.String> value) 静的データからIDを取得する。
java.util.List<java.lang.String>	getIndexNames() 全てのインデックス名を取得する。
java.util.Map<java.lang.String,java.lang.String>	getValue(java.lang.Object id) SQL文をロードする。
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getValues(java.lang.String indexName, java.lang.Object key) インデックスに紐付くデータをロードする。
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	loadAll() 全てのデータをロードする。
void	setExtension(java.lang.String extension) 拡張子を設定する。
void	setFileEncoding(java.lang.String fileEncoding) ファイルエンコーディングを設定する。

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

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

コンストラクタの詳細

BasicSqlLoader

public BasicSqlLoader()

メソッドの詳細

setFileEncoding

public void setFileEncoding(java.lang.String fileEncoding)

ファイルエンコーディングを設定する。

ここで設定されたエンコーディングを使用してSQLファイルを読み込む。 本設定を行わない場合は、JVMのデフォルトエンコーディングを使用してSQLファイルが読み込まれる。

パラメータ:

fileEncoding - ファイルエンコーディング

setExtension

public void setExtension(java.lang.String extension)

拡張子を設定する。
ここで設定された拡張子を付加したファイルをSQLファイルとして読み込む。 指定がない場合は、デフォルトで拡張子はsqlとなる。

パラメータ:

extension - 拡張子

getValue

public java.util.Map<java.lang.String,java.lang.String> getValue(java.lang.Object id)

SQL文をロードする。

定義:

getValue インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

パラメータ:

id - データのID(SQL文が書かれたファイルのリソース名)

戻り値:

ロードしたSQL文
KEY->SQL_ID
VALUE->SQL文

getValues

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getValues(java.lang.String indexName,
                                                                                  java.lang.Object key)

インデックスに紐付くデータをロードする。
本メソッドは、サポートしない。

定義:

getValues インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

パラメータ:

indexName - インデックス名

key - 静的データのキー

戻り値:

インデックス名、キーに対応するデータのリスト

loadAll

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> loadAll()

全てのデータをロードする。
本メソッドはサポートしない。

定義:

loadAll インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

戻り値:

全てのデータ

getIndexNames

public java.util.List<java.lang.String> getIndexNames()

全てのインデックス名を取得する。
本メソッドはサポートしない。

定義:

getIndexNames インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

戻り値:

全てのインデックス名

getId

public java.lang.Object getId(java.util.Map<java.lang.String,java.lang.String> value)

静的データからIDを取得する。
本メソッドはサポートしない。

定義:

getId インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

パラメータ:

value - 静的データ

戻り値:

生成したID

generateIndexKey

public java.lang.Object generateIndexKey(java.lang.String indexName,
                                         java.util.Map<java.lang.String,java.lang.String> value)

静的データからインデックスのキーを生成する。
本メソッドはサポートしない。

定義:

generateIndexKey インタフェース内 StaticDataLoader<java.util.Map<java.lang.String,java.lang.String>>

パラメータ:

indexName - インデックス名

value - 静的データ

戻り値:

生成したインデックスのキー