net.argius.stu.sql
クラス AbstractSQL

java.lang.Object
  拡張net.argius.stu.sql.AbstractSQL
すべての実装インタフェース:
SQL
直系の既知のサブクラス:
DeleteSQL, InsertSQL, SelectSQL, UpdateSQL

public abstract class AbstractSQL
extends Object
implements SQL

汎用SQLの基底クラスです。 stu.sql.SQLの基本的な実装と、 DML(SELECT, INSERT, UPDATE, DELETE)の共通となる機能が定義されています。

関連項目:
SQL

コンストラクタの概要
protected AbstractSQL()
          オブジェクトを初期化します。
 
メソッドの概要
 void addColumn(List list)
          選択するカラムをリスト単位で追加します。
 void addColumn(String name)
          選択するカラムを追加します。
 void addParameter(List list)
          プリコンパイル済みSQLのためのパラメータをセットします。
 void addParameter(String value)
          プリコンパイル済みSQLのためのパラメータをセットします。
protected abstract  void clearAll()
          オブジェクト固有の終了処理です。
 void clearColumn()
          選択されたカラムをクリアします。
 void clearParameter()
          プリコンパイル済みSQLのためのパラメータをクリアします。
 void close()
          オブジェクトをクローズします。
protected  String embedQueryString()
          プレースホルダをパラメータに置換えた状態のクエリ文字列を取得します。
 int execute()
          SQLを実行します。
protected abstract  int executeQuery(PreparedStatement statement)
          SQL実行の詳細です。
protected  List getColumns()
          カラム一覧を取得します。
protected  String getDatabaseName()
          DB製品名を返します。
protected  List getParameters()
          パラメータ一覧を取得します。
 String getQuery()
          クエリ文を取得します。
protected abstract  String getSQLString()
          SQL文字列を生成します。
protected  String getTable()
          テーブル名を取得します。
 String getValue(int index)
          このメソッドはこのクラスでは実装されていません。
 String getValue(String key)
          このメソッドはこのクラスでは実装されていません。
 List getValues()
          このメソッドはこのクラスでは実装されていません。
 boolean next()
          このメソッドはこのクラスでは実装されていません。
 void open(Connection conn, String table)
          オブジェクトをオープンします。
protected abstract  String partialInfo()
          オブジェクトの個別情報を取得します。
 void setQuery(String query)
          クエリ文をセットします。
 void setQueryTimeout(int seconds)
          SQLの実行を待つ秒数を設定します。
 String toString()
          このオブジェクトの文字列形式を取得します。
 String toVerboseString()
          このオブジェクトの詳細な情報を含む文字列を取得します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

AbstractSQL

protected AbstractSQL()
オブジェクトを初期化します。

メソッドの詳細

open

public final void open(Connection conn,
                       String table)
オブジェクトをオープンします。 既にオープンされている場合は、上書きされます。

定義:
インタフェース SQL 内の open
パラメータ:
conn - コネクション
table - テーブル名

addColumn

public final void addColumn(String name)
選択するカラムを追加します。

定義:
インタフェース SQL 内の addColumn
パラメータ:
name - カラム名

addColumn

public final void addColumn(List list)
選択するカラムをリスト単位で追加します。

定義:
インタフェース SQL 内の addColumn
パラメータ:
list - カラム名のリスト

clearColumn

public final void clearColumn()
選択されたカラムをクリアします。

定義:
インタフェース SQL 内の clearColumn

getQuery

public final String getQuery()
クエリ文を取得します。

定義:
インタフェース SQL 内の getQuery
戻り値:
クエリ文の文字列(基本的にWHERE句)

setQuery

public final void setQuery(String query)
クエリ文をセットします。 文法チェックやプレースホルダのチェックは行いません。

定義:
インタフェース SQL 内の setQuery
パラメータ:
query - クエリ文の文字列(基本的にWHERE句)

setQueryTimeout

public final void setQueryTimeout(int seconds)
SQLの実行を待つ秒数を設定します。

定義:
インタフェース SQL 内の setQueryTimeout
パラメータ:
seconds - 秒数 0以下が指定された場合は無制限

addParameter

public final void addParameter(String value)
プリコンパイル済みSQLのためのパラメータをセットします。

定義:
インタフェース SQL 内の addParameter
パラメータ:
value - パラメータ値

addParameter

public final void addParameter(List list)
プリコンパイル済みSQLのためのパラメータをセットします。

定義:
インタフェース SQL 内の addParameter
パラメータ:
list - パラメータ値のリスト

clearParameter

public final void clearParameter()
プリコンパイル済みSQLのためのパラメータをクリアします。

定義:
インタフェース SQL 内の clearParameter

execute

public int execute()
            throws SQLException
SQLを実行します。

定義:
インタフェース SQL 内の execute
戻り値:
更新された行数 SELECTの場合は常にゼロ
例外:
SQLException - SQL実行時のエラー

next

public boolean next()
             throws SQLException
このメソッドはこのクラスでは実装されていません。

定義:
インタフェース SQL 内の next
戻り値:
カーソル移動に成功した場合はtrue、失敗した場合はfalse
例外:
SQLException - 常にエラー

getValue

public String getValue(String key)
                throws SQLException
このメソッドはこのクラスでは実装されていません。

定義:
インタフェース SQL 内の getValue
パラメータ:
key - 列名
戻り値:
指定した列の値文字列
例外:
SQLException - 常にエラー

getValue

public String getValue(int index)
                throws SQLException
このメソッドはこのクラスでは実装されていません。

定義:
インタフェース SQL 内の getValue
パラメータ:
index - 列番号
戻り値:
指定した列の値文字列
例外:
SQLException - 常にエラー

getValues

public List getValues()
               throws SQLException
このメソッドはこのクラスでは実装されていません。

定義:
インタフェース SQL 内の getValues
戻り値:
値のリスト
例外:
SQLException - 常にエラー

close

public final void close()
                 throws SQLException
オブジェクトをクローズします。 フィールドは可能な限り単純かつ確実に初期化されます。 クローズの異常終了の場合でも、状態はクローズとなります。

定義:
インタフェース SQL 内の close
例外:
SQLException - クローズが正常に終了しなかった場合

getSQLString

protected abstract String getSQLString()
SQL文字列を生成します。 文法チェックなどは行いません。

戻り値:
SQL文字列

executeQuery

protected abstract int executeQuery(PreparedStatement statement)
                             throws SQLException
SQL実行の詳細です。

パラメータ:
statement - プリコンパイル済みステートメント
戻り値:
処理された件数(任意)
例外:
SQLException - SQL実行エラー

clearAll

protected abstract void clearAll()
                          throws SQLException
オブジェクト固有の終了処理です。

例外:
SQLException - SQL終了処理エラー

getTable

protected String getTable()
テーブル名を取得します。

戻り値:
テーブル名

getColumns

protected List getColumns()
カラム一覧を取得します。

戻り値:
カラム一覧

getParameters

protected List getParameters()
パラメータ一覧を取得します。

戻り値:
パラメータ一覧

partialInfo

protected abstract String partialInfo()
オブジェクトの個別情報を取得します。

戻り値:
オブジェクト情報

embedQueryString

protected String embedQueryString()
プレースホルダをパラメータに置換えた状態のクエリ文字列を取得します。

戻り値:
編集済クエリ文字列

getDatabaseName

protected String getDatabaseName()
                          throws SQLException
DB製品名を返します。

戻り値:
DB製品名
例外:
SQLException

toVerboseString

public String toVerboseString()
このオブジェクトの詳細な情報を含む文字列を取得します。

定義:
インタフェース SQL 内の toVerboseString
戻り値:
オブジェクトを示す文字列

toString

public String toString()
このオブジェクトの文字列形式を取得します。

定義:
インタフェース SQL 内の toString
戻り値:
オブジェクトを示す文字列