jp.littlesoft.data
クラス Params<E extends Serializable>

java.lang.Object
  jp.littlesoft.data.Row<E>
      jp.littlesoft.data.Params<E>

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

Serializable

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

UpdateSQL

public class Params<E extends Serializable>
extends Row<E>

パラメータクラス

名前をキーにした項目の定義とその値の集合です。

SQLDataProviderやWebSQLTableでは、このクラスをSQLパラメータを格納するために利用しています。
名前、データタイプ等を定義したColumnオブジェクトと、それに対応する値を保持しています。

バージョン:

1.3.0

作成者:

LittleSoft Corporation

関連項目:

Column, 直列化された形式

入れ子のクラスの概要

クラス jp.littlesoft.data.Row から継承された入れ子のクラス/インタフェース

Row.RowID, Row.Status

フィールドの概要

static char

SQL_PARAM SQLパラメータ形式文字です。

クラス jp.littlesoft.data.Row から継承されたフィールド

entity, status, values

コンストラクタの概要

Params(E... e)
Params オブジェクトを生成します。

メソッドの概要

void	addColumn(Column column) Column オブジェクトを追加します。
Column	addColumn(String columnName) 名前を指定してColumnオブジェクトを追加します。
Column	addColumn(String columnName, Column.Type dataType) 名前、データ型を指定してColumnオブジェクトを追加します。
Column	addColumn(String columnName, Column.Type dataType, Column.ParamType paramType) 名前、データ型、パラメータ型を指定してColumnオブジェクトを追加します。
void	clearColumns() 全 Column オブジェクトを削除します。
void	copyValues(Params<?> sourceParams) sourceParamsの各項目値がnullでないとき、その値を当オブジェクトにコピーします.
Column	getColumn(int index)
Column	getColumn(String name)
int	getColumnCount()
int	indexOfColumn(String name)
protected void	initializeValues()
boolean	isTypedRow()
String[]	names()
String	parseSQL(String sqlText) SQL文に含まれているパラメータを解析し、対応する Column オブジェクトを生成します。
void	setValue(String columnName, Serializable value) Row オブジェクトの引数 columnName で指定された列にjava.lang.Object値を設定します。
String	toString() Params オブジェクトの内容を文字列として取得します。
void	validate() パラメータオブジェクトに設定された全てのデータ値の検証を行います。

クラス jp.littlesoft.data.Row から継承されたメソッド

cancelUpdates, clear, getBigDecimal, getBigDecimal, getBinary, getBinary, getBoolean, getBoolean, getByte, getByte, getDate, getDate, getDouble, getDouble, getEntity, getFloat, getFloat, getInt, getInt, getLong, getLong, getObject, getObject, getOriginalRow, getRowID, getShort, getShort, getStatus, getString, getString, getTable, getTime, getTime, getTimestamp, getTimestamp, getValue, getValue, getValueAsString, getValueAsString, handleCompatiException, isDeletionDeserved, isDeletionReserved, isEditing, isNull, isNull, isNullAll, setBigDecimal, setBigDecimal, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setDate, setDate, setDeletionDeserved, setDeletionReserved, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setNull, setNull, setObject, setObject, setShort, setShort, setStatus, setString, setString, setTime, setTime, setTimestamp, setTimestamp, setValue, setValueAsString, setValueAsString, setValueFromResultSet, startEditing

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

SQL_PARAM

public static final char SQL_PARAM

SQLパラメータ形式文字です。

SQLのパラメータにつける接頭子です。(値=':')

関連項目:

定数フィールド値

コンストラクタの詳細

Params

public Params(E... e)

Params オブジェクトを生成します。

メソッドの詳細

names

public String[] names()

isTypedRow

public boolean isTypedRow()

オーバーライド:

クラス Row<E extends Serializable> 内の isTypedRow

initializeValues

protected void initializeValues()

オーバーライド:

クラス Row<E extends Serializable> 内の initializeValues

copyValues

public void copyValues(Params<?> sourceParams)
                throws DataException

sourceParamsの各項目値がnullでないとき、その値を当オブジェクトにコピーします.

パラメータ:

sourceParams -

例外:

DataException

getColumn

public Column getColumn(String name)
                 throws DataException

オーバーライド:

クラス Row<E extends Serializable> 内の getColumn

例外:

DataException

getColumn

public Column getColumn(int index)

オーバーライド:

クラス Row<E extends Serializable> 内の getColumn

indexOfColumn

public int indexOfColumn(String name)

オーバーライド:

クラス Row<E extends Serializable> 内の indexOfColumn

getColumnCount

public int getColumnCount()

オーバーライド:

クラス Row<E extends Serializable> 内の getColumnCount

addColumn

public Column addColumn(String columnName)
                 throws DataException

名前を指定してColumnオブジェクトを追加します。

※注意： データ型、パラメータ型はそれぞれディフォルト値のColumn.Type.UNKNOWN、 Column.ParamType.INが設定されます。

パラメータ:

columnName - 列名

戻り値:

作成された Column オブジェクト

例外:

DataException - 例外発生時

関連項目:

addColumn(String, Column.Type, Column.ParamType)

addColumn

public Column addColumn(String columnName,
                        Column.Type dataType)
                 throws DataException

名前、データ型を指定してColumnオブジェクトを追加します。

※注意： パラメータ型はColumn.ParamType.INが設定されます。

パラメータ:

columnName - 列名

dataType - データ型

戻り値:

作成された Column オブジェクト

例外:

DataException - 例外発生時

関連項目:

Column.Type, Column.ParamType, addColumn(String, Column.Type, Column.ParamType)

addColumn

public Column addColumn(String columnName,
                        Column.Type dataType,
                        Column.ParamType paramType)
                 throws DataException

名前、データ型、パラメータ型を指定してColumnオブジェクトを追加します。

   例:
   dataMap.addColumn("EMPLOYEE_ID", Column.Type.STRING, Column.ParamType.IN);
 

パラメータ:

columnName - 列名

dataType - データ型

paramType - パラメータ型

戻り値:

作成された Column オブジェクト

例外:

DataException - 例外発生時

関連項目:

Column.Type, Column.ParamType

addColumn

public void addColumn(Column column)
               throws DataException

Column オブジェクトを追加します。

パラメータ:

column - Column オブジェクト

例外:

DataException - 例外発生時

clearColumns

public void clearColumns()
                  throws DataException

全 Column オブジェクトを削除します。
型付けされている場合は、エンティティクラスのフィールド、セッターよりディフォルトのカラムオブジェクトが生成されます.

例外:

DataException - 例外発生時

parseSQL

public String parseSQL(String sqlText)
                throws DataException

SQL文に含まれているパラメータを解析し、対応する Column オブジェクトを生成します。

SQL文には "SELECT * FROM EMP WHERE EMPNO = :EMPNO" の様な形式でパラメータが指定されている必要があります。
戻り値は上記":EMPNO"が"?"にリプレースされたSQL文です。(上記の例では "SELECT * FROM EMP WHERE EMPNO = ?")

Column オブジェクトは Column.Type.UNKNOWN で生成されます。

※注意： SQL文中の "/*$ XXX $*/" もパラメータとして扱うことができます。
この例の場合は、"XXX"という名前の Column オブジェクトが Column.Type.STRING で生成されます。

パラメータ:

sqlText - 解析前のSQL文（:PARAM_NAMEを含むSQL文）

戻り値:

解析後のSQL文（:PARAM_NAMEが?に変換されたSQL文）

例外:

DataException - 例外発生時

toString

public String toString()

Params オブジェクトの内容を文字列として取得します。

クラス名、各フィールド名とその値を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

Params オブジェクトの文字列表現

validate

public void validate()
              throws DataException

パラメータオブジェクトに設定された全てのデータ値の検証を行います。

オーバーライド:

クラス Row<E extends Serializable> 内の validate

例外:

DataException

関連項目:

Row.validate()

setValue

public void setValue(String columnName,
                     Serializable value)
              throws DataException,
                     InvalidValueException

クラス Row の記述:

Row オブジェクトの引数 columnName で指定された列にjava.lang.Object値を設定します。

オーバーライド:

クラス Row<E extends Serializable> 内の setValue

パラメータ:

columnName - 列名

value - java.lang.Object型のデータ値

例外:

DataException - 例外発生時

InvalidValueException - 例外発生時