パッケージ com.github.mygreen.splate

クラス SqlTemplateEngine

  • public class SqlTemplateEngine
extends Object
    SQLテンプレートを管理します。
    作成者:
    T.TSUCHIE

    • コンストラクタの詳細

      • SqlTemplateEngine

        public SqlTemplateEngine()

    • メソッドの詳細

      • getTemplate

        public SqlTemplate getTemplate​(@NonNull
                               @NonNull String location)
        SQLファイルのリソースパスを指定して、SQLテンプレートを取得します。

        SQLファイルのリソースは、Springの ResourceLoader 経由で取得するため、 接頭語を付けることで複数のリソースを参照できます。

        • 何もつけない場合 - クラスパスから取得します。ex)/sql/hoge.sql
        • classpath: - クラスパスから取得します。ex)classpath:/sql/hoge.sql
        • file: - システムファイルから取得します。ex)file:c:/sql/hoge.sql
        • http: - URLからファイルを取得します。ex)http://hoge.com/sql/hoge.sql
        パラメータ:
        location - SQLファイルのリソースパス。
        戻り値:
        パースしたSQLテンプレート
        例外:
        TwoWaySqlException - SQLファイルの読み込みやパースに失敗した場合にスローされます。

      • getTemplate

        public SqlTemplate getTemplate​(@NonNull
                               @NonNull org.springframework.core.io.Resource resource)
        SQLファイルのリソースを指定して、SQLテンプレートを取得します。
        パラメータ:
        resource - SQLファイルのリソース。
        戻り値:
        パースしたSQLテンプレート
        例外:
        TwoWaySqlException - SQLファイルの読み込みやパースに失敗した場合にスローされます。

      • getTemplateByText

        public SqlTemplate getTemplateByText​(@NonNull
                                     @NonNull String sql)
        SQLを文字列として直接指定し、SQLテンプレートを取得します。
        パラメータ:
        sql - SQLの文字列
        戻り値:
        パースしたSQLテンプレート
        例外:
        TwoWaySqlException - SQLファイルの読み込みやパースに失敗した場合にスローされます。

      • createSqlParser

        protected SqlParser createSqlParser​(String sql)
        SqlParser のインスタンスを作成します。
        パラメータ:
        sql - パース対象のSQLテンプレート
        戻り値:
        SqlParser のインスタンス

      • clearCache

        public void clearCache()
        現在キャッシュしている情報をクリアします。

      • getEncoding

        public String getEncoding()
        SQLテンプレートファイルの文字コード名。 デフォルト値は、UTF-8 です。

      • setEncoding

        public void setEncoding​(String encoding)
        SQLテンプレートファイルの文字コード名。 デフォルト値は、UTF-8 です。

      • getSuffixName

        public String getSuffixName()
        SQLテンプレートのファイル名の接尾語。 DBの種類によって読み込み対象のファイルを切り替えたい場合に指定します。 デフォルト値は、null です。

      • setSuffixName

        public void setSuffixName​(String suffixName)
        SQLテンプレートのファイル名の接尾語。 DBの種類によって読み込み対象のファイルを切り替えたい場合に指定します。 デフォルト値は、null です。

      • getResourceLoader

        public org.springframework.core.io.ResourceLoader getResourceLoader()
        テンプレートファイルなどのリソースをロードする処理。 デフォルト値は、DefaultResourceLoader のインスタンスです。

      • setResourceLoader

        public void setResourceLoader​(org.springframework.core.io.ResourceLoader resourceLoader)
        テンプレートファイルなどのリソースをロードする処理。 デフォルト値は、DefaultResourceLoader のインスタンスです。

      • getTemplateLoader

        public TemplateLoader getTemplateLoader()
        SQLテンプレートファイルの読み込む処理。

      • setTemplateLoader

        public void setTemplateLoader​(TemplateLoader templateLoader)
        SQLテンプレートファイルの読み込む処理。

      • getExpressionParser

        public org.springframework.expression.spel.standard.SpelExpressionParser getExpressionParser()
        EL式のパーサ

      • setExpressionParser

        public void setExpressionParser​(org.springframework.expression.spel.standard.SpelExpressionParser expressionParser)
        EL式のパーサ

      • isCached

        public boolean isCached()
        パースしたんプレートをキャッシュするかどうか。 デフォルトでは false でキャッシュしない設定です。

      • setCached

        public void setCached​(boolean cached)
        パースしたんプレートをキャッシュするかどうか。 デフォルトでは false でキャッシュしない設定です。