StatementBuilder (jdbc-util 0.3.3 API)

java.lang.Object
- net.osdn.util.sql.StatementBuilder

直系の既知のサブクラス:

DefaultStatementBuilder, H2StatementBuilder, HsqldbStatementBuilder, MssqlStatementBuilder
```
public abstract class StatementBuilder
extends java.lang.Object
```
オブジェクトからSQL文を構築するためのビルダークラスです。
データベースごとのSQL構文差異を吸収するために、データベース固有のビルダーを追加することができます。

既定で以下のビルダーが追加されています。
- H2StatementBuilder (H2)
- HsqldbStatementBuilder (H2)
- MssqlStatementBuilder (SQL Server)

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

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

StatementBuilder()

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`add(StatementBuilder builder)` SQLを構築するビルダーを追加します。
`NamedParameterStatement`	`createDeleteStatement(java.sql.DatabaseMetaData md, java.lang.Class<?> cls, java.lang.String tableName)` 指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするDELETE文を構築します。
`NamedParameterStatement`	`createInsertStatement(java.sql.DatabaseMetaData md, java.lang.Class<?> cls, java.lang.String tableName)` 指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするINSERT文を構築します。
`NamedParameterStatement`	`createMergeStatement(java.sql.DatabaseMetaData md, java.lang.Class<?> cls, java.lang.String tableName)` 指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするMERGE文を構築します。
`NamedParameterStatement`	`createSelectStatement(java.sql.DatabaseMetaData md, java.lang.Class<?> cls, java.lang.String tableName, java.lang.Object obj)` 指定されたデータベース・メタデータ、クラス、テーブル名、オブジェクトから名前付きパラメーターをサポートするSELECT文を構築します。
`NamedParameterStatement`	`createUpdateStatement(java.sql.DatabaseMetaData md, java.lang.Class<?> cls, java.lang.String tableName)` 指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするUPDATE文を構築します。
`static StatementBuilder`	`getInstance(java.sql.DatabaseMetaData md)` 指定したデータベース・メタデータに適合する構文ビルダーを取得します。
`abstract boolean`	`isAcceptable(java.sql.DatabaseMetaData md)` 指定されたデータベース・メタデータが、この構文ビルダーに適合するかどうかをチェックします。

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

- コンストラクタの詳細
  - StatementBuilder
```
public StatementBuilder()
```
- メソッドの詳細
  - add
```
public static void add(StatementBuilder builder)
```
    SQLを構築するビルダーを追加します。
    
    パラメータ:
    
    builder - SQLを構築するビルダー
  - getInstance
```
public static StatementBuilder getInstance(java.sql.DatabaseMetaData md)
```
    指定したデータベース・メタデータに適合する構文ビルダーを取得します。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    戻り値:
    
    適合する構文ビルダー。適合する構文ビルダーが追加されていない場合は既定の構文ビルダーが返されます。
  - isAcceptable
```
public abstract boolean isAcceptable(java.sql.DatabaseMetaData md)
                              throws java.lang.Exception
```
    指定されたデータベース・メタデータが、この構文ビルダーに適合するかどうかをチェックします。
    データベース固有の構文ビルダーはデータベース・メタデータからデータベースの製品名などの情報を参照して、構文ビルダーがサポートするデータベースかどうかをチェックする必要があります。
    
    パラメータ:
    
    md - データベース製品を特定するために参照されるデータベース・メタデータ
    
    戻り値:
    
    この構文ビルダーが指定されたメタデータからデータベースをサポートする場合はtrue、そうでなければfalse
    
    例外:
    
    java.lang.Exception - 構文ビルダー固有の例外がスローされることがあります。(主にSQLException)
  - createSelectStatement
```
public NamedParameterStatement createSelectStatement(java.sql.DatabaseMetaData md,
                                                     java.lang.Class<?> cls,
                                                     java.lang.String tableName,
                                                     java.lang.Object obj)
                                              throws java.sql.SQLException
```
    指定されたデータベース・メタデータ、クラス、テーブル名、オブジェクトから名前付きパラメーターをサポートするSELECT文を構築します。
    tableNameにnull以外の値が指定された場合、これをテーブル名として扱います。 tableNameがnullの場合にはclsをテーブル名として扱います。
    
    objのフィールドはSELECT文のWHERE句を構成する列名として使用されます。 objがnullの場合にはWHERE句を持たない、つまりすべての行を返すSELECT文が構築されます。
    
    このメソッドが返す名前付きパラメーター・ステートメントはパラメーターの値が設定されていない状態です。 objのフィールドはWHERE句に出現する列名を決定することにのみに使用され、列の値には作用しません。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    cls - テーブル名を表すクラス
    
    tableName - テーブル名。nullを指定した場合はclsをテーブル名として扱います。
    
    obj - WHERE句に指定される列を指定するオブジェクトです。
    
    戻り値:
    
    名前付きパラメーターを持つ
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - createInsertStatement
```
public NamedParameterStatement createInsertStatement(java.sql.DatabaseMetaData md,
                                                     java.lang.Class<?> cls,
                                                     java.lang.String tableName)
                                              throws java.sql.SQLException
```
    指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするINSERT文を構築します。
    tableNameにnull以外の値が指定された場合、これをテーブル名として扱います。 tableNameがnullの場合にはclsをテーブル名として扱います。
    
    clsのフィールドはINSERT文のVALUES句を構成する列名として使用されます。
    
    このメソッドが返す名前付きパラメーター・ステートメントはパラメーターの値が設定されていない状態です。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    cls - テーブル名を表すクラス。フィールドはVALUES句の列名として扱われます。
    
    tableName - テーブル名。nullを指定した場合はclsをテーブル名として扱います。
    
    戻り値:
    
    名前付きパラメーターを持つINSERT文
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - createUpdateStatement
```
public NamedParameterStatement createUpdateStatement(java.sql.DatabaseMetaData md,
                                                     java.lang.Class<?> cls,
                                                     java.lang.String tableName)
                                              throws java.sql.SQLException
```
    指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするUPDATE文を構築します。
    tableNameにnull以外の値が指定された場合、これをテーブル名として扱います。 tableNameがnullの場合にはclsをテーブル名として扱います。
    
    clsのフィールドはUPDATE文のSET句またはWHERE句を構成する列名として使用されます。データベース・メタデータからテーブルのスキーマを参照しテーブルの行を一意に特定するための列を求めます。行を一意に特定するための列と行バージョン列はWHERE句に指定されます。WHERE句に指定される列が少なくとも1つ以上必要です。その他の列はSET句に指定されます。(ただし自動インクリメント列は除外されます。)
    
    このメソッドが返す名前付きパラメーター・ステートメントはパラメーターの値が設定されていない状態です。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    cls - テーブル名を表すクラス。フィールドはSET句またはWHERE句の列名として扱われます。
    
    tableName - テーブル名。nullを指定した場合はclsをテーブル名として扱います。
    
    戻り値:
    
    名前付きパラメーターを持つUPDATE文
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - createDeleteStatement
```
public NamedParameterStatement createDeleteStatement(java.sql.DatabaseMetaData md,
                                                     java.lang.Class<?> cls,
                                                     java.lang.String tableName)
                                              throws java.sql.SQLException
```
    指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするDELETE文を構築します。
    tableNameにnull以外の値が指定された場合、これをテーブル名として扱います。 tableNameがnullの場合にはclsをテーブル名として扱います。
    
    clsのフィールドはDELETE文のWHERE句を構成する列名として使用されます。データベース・メタデータからテーブルのスキーマを参照しテーブルの行を一意に特定するための列を求めます。行を一意に特定するための列と行バージョン列はWHERE句に指定されます。WHERE句に指定される列が少なくとも1つ以上必要です。その他の列は無視されます。
    
    このメソッドが返す名前付きパラメーター・ステートメントはパラメーターの値が設定されていない状態です。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    cls - テーブル名を表すクラス。フィールドの一部はWHERE句の列名として扱われます。
    
    tableName - テーブル名。nullを指定した場合はclsをテーブル名として扱います。
    
    戻り値:
    
    名前付きパラメーターを持つDELETE文
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - createMergeStatement
```
public NamedParameterStatement createMergeStatement(java.sql.DatabaseMetaData md,
                                                    java.lang.Class<?> cls,
                                                    java.lang.String tableName)
                                             throws java.sql.SQLException
```
    指定されたデータベース・メタデータ、クラス、テーブル名から名前付きパラメーターをサポートするMERGE文を構築します。
    tableNameにnull以外の値が指定された場合、これをテーブル名として扱います。 tableNameがnullの場合にはclsをテーブル名として扱います。
    
    clsのフィールドはMERGE文を構成する列名として使用されます。
    
    このメソッドが返す名前付きパラメーター・ステートメントはパラメーターの値が設定されていない状態です。
    
    パラメータ:
    
    md - データベース・メタデータ
    
    cls - テーブル名を表すクラス。フィールドの一部は列名として扱われます。
    
    tableName - テーブル名。nullを指定した場合はclsをテーブル名として扱います。
    
    戻り値:
    
    名前付きパラメーターを持つMERGE文
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合

クラス StatementBuilder

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

メソッドのサマリー

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

コンストラクタの詳細

StatementBuilder

メソッドの詳細

add

getInstance

isAcceptable

createSelectStatement

createInsertStatement

createUpdateStatement

createDeleteStatement

createMergeStatement