ts.query
クラス QueryContext

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

public class QueryContext
extends ts.util.AbstractTypedGetter<java.lang.Enum,java.lang.Object>

クエリの実行内容を格納するためのクラス。
接続先を識別するコネクションID、実行内容を識別するクエリID、 クエリ・リソース・オブジェクトを取得するためのメソッドを備えている。 また、入力データ名の列挙、出力データ名の列挙を行うメソッドも用意している。
さらに、このクラスはTypedGetterインターフェイスを インプリメントしており、クエリに応じたコンテキスト情報を基本データ型や 文字列、DateTimeオブジェクトに変換して取得することが可能 である。
このクラスのインスタンスは、実行結果オブジェクトの属性としても使用される。

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

コンストラクタの概要
QueryContext(java.lang.String connId, java.lang.String queryId)
          コネクションIDとクエリIDを引数にとるコンストラクタ。
 
メソッドの概要
 void addInputName(java.lang.String name)
          入力パラメータ名を追加する。
 void addInputNames(java.util.Collection<java.lang.String> names)
          複数の入力パラメータ名を追加する。
 void addInputNames(java.lang.String[] names)
          複数の入力パラメータ名を追加する。
 void addOutput(QueryOutput output)
          出力項目を追加する。
 void addOutputs(java.util.Collection<QueryOutput> outputs)
          複数の出力項目を追加する。
 void addOutputs(QueryOutput[] outputs)
          複数の出力項目を追加する。
 int countInputNames()
          クエリ・リソースの中に含まれる全ての入力パラメータ名の数を取得する。
 int countOutputNames()
          クエリ・リソースの中に含まれる全ての出力パラメータ名の数を取得する。
 java.util.Enumeration<java.lang.String> enumInputNames()
          クエリ・リソースの中に含まれる全ての入力パラメータ名を列挙する。
 java.util.Enumeration<java.lang.String> enumOutputNames()
          クエリ・リソースの中に含まれる全ての出力パラメータ名を列挙する。
 java.lang.Object get(java.lang.Enum key)
          指定されたキーに結びつけられたコンテキスト情報データを取得する。
 java.lang.String getConnectionId()
          コネクションIDを取得する。
 java.lang.String getQueryId()
          クエリIDを取得する。
 boolean hasResultTable()
          クエリが結果テーブルを返すかどうかを取得する。
 void set(java.lang.Enum key, java.io.Serializable value)
          指定されたキーに対するコンテキスト情報データを設定する。
 
クラス 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
 

コンストラクタの詳細

QueryContext

public QueryContext(java.lang.String connId,
                    java.lang.String queryId)
コネクションIDとクエリIDを引数にとるコンストラクタ。

パラメータ:
connId - コネクションID。
queryId - クエリID。
メソッドの詳細

getQueryId

public java.lang.String getQueryId()
クエリIDを取得する。

戻り値:
クエリID。

getConnectionId

public java.lang.String getConnectionId()
コネクションIDを取得する。

戻り値:
コネクションID。

get

public java.lang.Object get(java.lang.Enum key)
指定されたキーに結びつけられたコンテキスト情報データを取得する。

定義:
クラス ts.util.AbstractTypedGetter<java.lang.Enum,java.lang.Object> 内の get
パラメータ:
key - キー。
戻り値:
引数のキーに結びつけられたコンテキスト情報データ。

set

public void set(java.lang.Enum key,
                java.io.Serializable value)
指定されたキーに対するコンテキスト情報データを設定する。
引数の値がヌルの場合は、指定されたキーのコンテキスト情報データのエントリ を削除する。

パラメータ:
key - キー。
value - 引数のキーに結びつけられるコンテキスト情報データ。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグ・モードのみ)。

hasResultTable

public boolean hasResultTable()
クエリが結果テーブルを返すかどうかを取得する。
クエリの内容が結果テーブルを返すものであるかどうかを判別し、結果テーブルを 返す場合はtrueを返す。

戻り値:
結果テーブルを返す場合はtrue

enumInputNames

public java.util.Enumeration<java.lang.String> enumInputNames()
クエリ・リソースの中に含まれる全ての入力パラメータ名を列挙する。
入力パラメータ名の重複は除かれて出力される。

戻り値:
入力パラメータ名を格納した列挙オブジェクト。

countInputNames

public int countInputNames()
クエリ・リソースの中に含まれる全ての入力パラメータ名の数を取得する。
入力パラメータ名の重複は除かれて数えられる。

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

enumOutputNames

public java.util.Enumeration<java.lang.String> enumOutputNames()
クエリ・リソースの中に含まれる全ての出力パラメータ名を列挙する。
出力パラメータ名の重複は除かれて出力される。

戻り値:
出力パラメータ名を格納した列挙オブジェクト。

countOutputNames

public int countOutputNames()
クエリ・リソースの中に含まれる全ての出力パラメータ名の数を取得する。
出力パラメータ名の重複は除かれて数えられる。

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

addInputName

public void addInputName(java.lang.String name)
入力パラメータ名を追加する。

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

addInputNames

public void addInputNames(java.util.Collection<java.lang.String> names)
複数の入力パラメータ名を追加する。

パラメータ:
names - 入力パラメータ名のコレクション。
例外:
java.lang.AssertionError - 引数や引数のコレクションの要素がヌルの場合 (デバッグ・モードのみ)。

addInputNames

public void addInputNames(java.lang.String[] names)
複数の入力パラメータ名を追加する。

パラメータ:
names - 入力パラメータ名の配列。
例外:
java.lang.AssertionError - 引数や引数の配列の要素がヌルの場合 (デバッグ・モードのみ)。

addOutput

public void addOutput(QueryOutput output)
出力項目を追加する。

パラメータ:
output - 出力項目オブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグ・モードのみ)。

addOutputs

public void addOutputs(java.util.Collection<QueryOutput> outputs)
複数の出力項目を追加する。

パラメータ:
outputs - 出力項目オブジェクトのコレクション。
例外:
java.lang.AssertionError - 引数や引数のコレクションの要素がヌルの場合 (デバッグ・モードのみ)。

addOutputs

public void addOutputs(QueryOutput[] outputs)
複数の出力項目を追加する。

パラメータ:
outputs - 出力項目オブジェクトの配列k。
例外:
java.lang.AssertionError - 引数や引数の配列の要素がヌルの場合 (デバッグ・モードのみ)。


Copyright (C) SATOH Takayuki All Rights Reserved.