org.seasar.doma.jdbc
インタフェース SqlFileRepository

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

AbstractSqlFileRepository, GreedyCacheSqlFileRepository, NoCacheSqlFileRepository

public interface SqlFileRepository

SqlFile のリポジトリです。

SQLファイルのパスは次の制約を満たさねばなりません。

• 'META-INF/'で始まる。
• その後ろに、 Dao が注釈されたインタフェースの完全修飾名の . を / に置換したものが続く。
• その後ろに、/ が続く。
• その後ろに、Dao が注釈されたインタフェースのメンバメソッド名が続く。
• '.sql'で終わる。ただし、'.sql'の前にハイフン区切りでRDBMSの名前を指定可能。

SQLファイルのパスの例

META-INF/org/example/ExampleDao/selectAll.sql

このインタフェースの実装クラスは、まず、RDBMS固有のSQLファイルがあるかどうか調べ、あればそちらを使用しなければいけません。 RDBMS固有のSQLファイルのパスは、 '.sql'の直前に次の2種類の文字列を挿入することで求められます。

• -（ハイフン）
• Dialect.getName() で返される値。

RDBMS固有のSQLファイルのパスの例

META-INF/org/example/ExampleDao/selectAll-oracle.sql

このインタフェースの実装はスレッドセーフでなければいけません。

作成者:

taedium

メソッドの概要

SqlFile

getSqlFile(String path, Dialect dialect) SQLファイルを返します。

メソッドの詳細

getSqlFile

SqlFile getSqlFile(String path,
                   Dialect dialect)

SQLファイルを返します。

パラメータ:

path - SQLファイルのパス

dialect - 方言

戻り値:

SQLファイル

例外:

DomaNullPointerException - 引数のいずれかが null の場合

DomaIllegalArgumentException - path が'META-INF/'で始まらない場合、 もしくは、path が'.sql'で終わらない場合

SqlFileNotFoundException - SQLファイルが見つからない場合

JdbcException - 上記以外で例外が発生した場合