ts.query
クラス QueryParam

java.lang.Object
  上位を拡張 ts.util.AbstractTypedGetter<java.lang.String,java.io.Serializable>
      上位を拡張 ts.query.QueryParam
すべての実装されたインタフェース:
java.io.Serializable, ts.util.TypedGetter<java.lang.String>

public class QueryParam
extends ts.util.AbstractTypedGetter<java.lang.String,java.io.Serializable>

クエリ・パラメータ・クラス。
クエリの実行内容に適用するパラメータを表すクラス。 パラメータの名前、値を属性に持ち、その他にデータ型などの情報を任意の属性 として保持することができる。
getValue()メソッドは、値が単数の場合はその値を常に返す。値が複数の 場合はそれらの値を順番に返して最後に至った後は最後の値を返し続ける。

バージョン:
$Id: QueryParam.java,v 1.7 2011-09-18 16:15:16 tayu Exp $
作成者:
佐藤隆之
関連項目:
直列化された形式

入れ子のクラスの概要
static class QueryParam.IO
          入出力区分を表す列挙型。
 
コンストラクタの概要
QueryParam(java.lang.String name)
          パラメータ名を引数にとるコンストラクタ。
QueryParam(java.lang.String name, QueryParam.IO io)
          パラメータ名と入出力区分を引数にとるコンストラクタ。
 
メソッドの概要
 int countValues()
          パラメータ値の数を取得する。
 java.io.Serializable get(java.lang.String key)
          指定されたキーに結びつけられた属性値を取得する。
 QueryParam.IO getIO()
          パラメータの入出力区分を取得する。
 java.lang.String getName()
          パラメータ名を取得する。
 java.lang.Object getValue()
          パラメータ値を取得する。
 java.lang.Object put(java.lang.String key, java.io.Serializable attrValue)
          指定されたキーを属性名とする属性値を設定する。
 void setValue(java.lang.Object paramValue)
          パラメータ値を設定する。
protected  java.util.Collection<java.io.Serializable> toCollection(java.lang.Object obj)
          オブジェクトがCollectionオブジェクトに型変換する。
 
クラス ts.util.AbstractTypedGetter から継承されたメソッド
addTrueObject, getBigDecimal, getBoolean, getDateTime, getDateTimeString, getDouble, getFloat, getInteger, getList, getLong, getNumberString, getString, limit, limit, limit, limit, removeTrueObject, setDateTimeFormat, setDateTimeFormat
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

QueryParam

public QueryParam(java.lang.String name)
パラメータ名を引数にとるコンストラクタ。
入出力区分は入力、値はヌルに指定される。

パラメータ:
name - パラメータ名。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグ・モードのみ)。

QueryParam

public QueryParam(java.lang.String name,
                  QueryParam.IO io)
パラメータ名と入出力区分を引数にとるコンストラクタ。
値はヌルに指定される。

パラメータ:
name - パラメータ名。
io - 入出力区分。
例外:
AsserionError - 引数がヌルの場合(デバッグ・モードのみ)。
メソッドの詳細

getName

public java.lang.String getName()
パラメータ名を取得する。

戻り値:
パラメータ名。

getIO

public QueryParam.IO getIO()
パラメータの入出力区分を取得する。

戻り値:
パラメータの入出力区分。

get

public java.io.Serializable get(java.lang.String key)
指定されたキーに結びつけられた属性値を取得する。

定義:
クラス ts.util.AbstractTypedGetter<java.lang.String,java.io.Serializable> 内の get
パラメータ:
key - キー。
戻り値:
属性値。

put

public java.lang.Object put(java.lang.String key,
                            java.io.Serializable attrValue)
指定されたキーを属性名とする属性値を設定する。

パラメータ:
key - キー。
attrValue - 属性値。
戻り値:
以前このキーに結びつけられていた属性値。

setValue

public void setValue(java.lang.Object paramValue)
パラメータ値を設定する。
引数はコレクション・オブジェクト又は配列の場合は複数の値を持つものとし、 それ以外は単数の値を持つものとして設定する。


getValue

public java.lang.Object getValue()
パラメータ値を取得する。
値が単数の場合はその値を常に返し、値が複数の場合はそれらの値を順番に返して 最後に至った後は最後の値を返し続ける。


countValues

public int countValues()
パラメータ値の数を取得する。

戻り値:
パラメータ値の数。

toCollection

protected java.util.Collection<java.io.Serializable> toCollection(java.lang.Object obj)
オブジェクトがCollectionオブジェクトに型変換する。

パラメータ:
obj - オブジェクト。
戻り値:
コレクション・オブジェクト。


Copyright (C) SATOH Takayuki All Rights Reserved.