BasicSqlParameterParser (Nablarch-API)

java.lang.Object
- nablarch.core.db.statement.BasicSqlParameterParser

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

SqlParameterParser
```
public class BasicSqlParameterParser
extends java.lang.Object
implements SqlParameterParser
```
名前付きバインド変数を持つSQL文を解析するクラス。
SQLの解析は、下記ルールにしたがい行う。
- 名前付き変数は「:」で開始される。
- 名前付き変数は、英字(大文字、小文字)、数字、アンダースコア(_)、パーセント(%)で構成されている。
- リテラルは、シングルクォートで囲われている。
- シングルクォートのエスケープは、シングルクォートである。
- リテラル内に名前付き変数のルールに一致する文字列があっても、名前付き変数として扱わない。
- コメントは存在しない。(コメント内に名前付き変数のルールに一致する文字列があった場合、名前付き変数として扱うためSQL実行時エラーが発生する。)
- SQL文の妥当性チェックは行わない。(構文エラーがあった場合は、SQLの実行時エラーとなる。)
本クラスは、解析したSQLの情報を保持するためスレッドアンセーフである。

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

コンストラクタ
コンストラクタと説明

BasicSqlParameterParser()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.lang.String`	`convertToJdbcSql(java.lang.String sql, java.lang.Object obj)` Nablarchの拡張構文が埋め込まれたSQL文をJDBC標準のSQL文(バインド変数を「?」
`java.util.List<java.lang.String>`	`getNameList()` 名前付きバインド変数のリストを取得する。
`java.lang.String`	`getSql()` SQL文を取得する。
`void`	`parse(java.lang.String sql)` SQL文を解析する。
`void`	`setLikeEscapeChar(char likeEscapeChar)` エスケープ文字を設定する。
`void`	`setSqlConvertors(java.util.List<SqlConvertor> sqlConvertors)` SqlConvertorのリストを設定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - BasicSqlParameterParser
```
public BasicSqlParameterParser()
```
- メソッドの詳細
  - parse
```
public void parse(java.lang.String sql)
```
    SQL文を解析する。
    
    定義:
    
    parse インタフェース内 SqlParameterParser
    
    パラメータ:
    
    sql - 名前付きバインド変数を持つSQL文
  - convertToJdbcSql
```
public java.lang.String convertToJdbcSql(java.lang.String sql,
                                         java.lang.Object obj)
```
    Nablarchの拡張構文が埋め込まれたSQL文をJDBC標準のSQL文(バインド変数を「?」に置き換えたSQL)に変換する。
    Nablarchの拡張構文の変換には、デフォルトで下記のSqlConvertorを使用する。
    定義:
    
    convertToJdbcSql インタフェース内 SqlParameterParser
    
    パラメータ:
    
    sql - SQL文
    
    obj - 検索条件をもつオブジェクト
    
    戻り値:
    
    変換後のSQL文
  - getSql
```
public java.lang.String getSql()
```
    SQL文を取得する。
    返却されるSQL文は、名前付きバインド変数部を「?」に置き換えたSQL
    
    定義:
    
    getSql インタフェース内 SqlParameterParser
    
    戻り値:
    
    SQL文
  - getNameList
```
public java.util.List<java.lang.String> getNameList()
```
    名前付きバインド変数のリストを取得する。
    名前付きバインド変数は、「?」の位置順にリストに格納されている。
    
    定義:
    
    getNameList インタフェース内 SqlParameterParser
    
    戻り値:
    
    名前付きバインド変数リスト
  - setLikeEscapeChar
```
public void setLikeEscapeChar(char likeEscapeChar)
```
    エスケープ文字を設定する。
    SQL文のlike句に埋め込む条件のエスケープに使用する文字を設定する。ここで設定した文字は、like条件のescape句に自動設定される。
    String sql = "select user_id, user_kanji_name from usr where user_kanji_name like :%userKanjiName"; BasicSqlParameterParser parser = new BasicSqlParameterParser(); parser.setLikeEscapeChar("\"); parser.parse(sql); parser.getSql(); -> select user_id, user_kanji_name from usr where user_kanji_name like ? ESCAPE '\'
    定義:
    
    setLikeEscapeChar インタフェース内 SqlParameterParser
    
    パラメータ:
    
    likeEscapeChar - エスケープ文字
  - setSqlConvertors
```
public void setSqlConvertors(java.util.List<SqlConvertor> sqlConvertors)
```
    SqlConvertorのリストを設定する。
    
    パラメータ:
    
    sqlConvertors - SqlConvertorのリスト

クラス BasicSqlParameterParser

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

メソッドのサマリー

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

コンストラクタの詳細

BasicSqlParameterParser

メソッドの詳細

parse

convertToJdbcSql

getSql

getNameList

setLikeEscapeChar

setSqlConvertors