ts.query
クラス QueryResultList

java.lang.Object
  上位を拡張 ts.query.QueryResultList
すべての実装されたインタフェース:
java.io.Serializable
直系の既知のサブクラス:
QueryResultList.ThreadSafeQueryResultList

public class QueryResultList
extends java.lang.Object
implements java.io.Serializable

複数のクエリ結果オブジェクトを格納するためのクラス。
複数のクエリを実行するQuery.executeSet(String[], Map) などのメソッドの戻り値として、またトランザクションの中で実行された複数の クエリの実行履歴として使用される。
isSuccess()メソッドは、格納されている結果オブジェクトの中に1つでも 失敗したものがあればfalseを返し、全てが成功の場合に限り trueを返す。
getSpentTimeMillis()メソッドは、デフォルトでは格納されている 結果オブジェクトの処理時間の合計を返すが、setSpentTimeMillis(long) メソッドを使って処理時間を設定した場合はその値を返す。
また、格納されている結果オブジェクトを様々な方法で取り出すメソッドを用意 している: 最初に格納されている結果オブジェクトを取得するメソッド、最後に格納されている 結果オブジェクトを取得するメソッド、クエリIDをキーに取得するメソッド、 例外オブジェクトをキーに取得するメソッド等がある。

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

入れ子のクラスの概要
protected static class QueryResultList.ThreadSafeQueryResultList
          コンストラクタで指定されたQueryResultListオブジェクトをスレッド・ セーフ化した結果リスト・オブジェクト。
 
コンストラクタの概要
QueryResultList()
          デフォルト・コンストラクタ。
 
メソッドの概要
 void addResult(QueryResult result)
          クエリの結果オブジェクトを追加する。
 int countResults()
          このオブジェクトに格納されている結果オブジェクトの数を取得する。
protected  void entryMappedList(java.util.Map<java.lang.String,java.util.List<QueryResult>> map, java.lang.String key, QueryResult result)
          指定されたキーに対応づけられたリストに結果オブジェクトを登録する。
 java.util.List<QueryResult> getAllResults()
          このオブジェクトに格納されている全ての結果オブジェクトのリストを取得する。
 QueryResult getFirstResult()
          このオブジェクトに格納されている最初の結果オブジェクトを取得する。
 QueryResult getFirstResultByConnectionId(java.lang.String connId)
          指定されたコネクションIDに対する最初の結果オブジェクトを取得する。
 QueryResult getFirstResultByQueryId(java.lang.String queryId)
          指定されたクエリIDに対する最初の結果オブジェクトを取得する。
 QueryResult getLastResult()
          このオブジェクトに格納されている最後の結果オブジェクトを取得する。
 QueryResult getLastResultByConnectionId(java.lang.String connId)
          指定されたコネクションIDに対する結果オブジェクトのリストを取得する。
 QueryResult getLastResultByQueryId(java.lang.String queryId)
          指定されたクエリIDに対する結果オブジェクトのリストを取得する。
 QueryResult getResultByException(ts.util.ReasonedException exc)
          指定された例外オブジェクトを持った結果オブジェクトのリストを取得する。
 java.util.List<QueryResult> getResultsByConnectionId(java.lang.String connId)
          指定されたコネクションIDに対する結果オブジェクトのリストを取得する。
 java.util.List<QueryResult> getResultsByQueryId(java.lang.String queryId)
          指定されたクエリIDに対する結果オブジェクトのリストを取得する。
 long getSpentTimeMillis()
          複数のクエリを実行するのに要した時間を取得する。
 boolean isSuccess()
          複数のクエリが全て成功したかどうかを取得する。
 void resetSpentTimeMillis()
          複数のクエリを全て実行するのに要した時間をリセットする。
 void setSpentTimeMillis(long millis)
          複数のクエリを全て実行するのに要した時間を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

QueryResultList

public QueryResultList()
デフォルト・コンストラクタ。

メソッドの詳細

addResult

public void addResult(QueryResult result)
クエリの結果オブジェクトを追加する。

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

entryMappedList

protected void entryMappedList(java.util.Map<java.lang.String,java.util.List<QueryResult>> map,
                               java.lang.String key,
                               QueryResult result)
指定されたキーに対応づけられたリストに結果オブジェクトを登録する。

パラメータ:
map - 登録先のマップ。
key - キー。
result - 登録される結果オブジェクト。

isSuccess

public boolean isSuccess()
複数のクエリが全て成功したかどうかを取得する。
このオブジェクトに格納されている複数の結果オブジェクトが全て成功かどうかを 調べる。 このオブジェクトに一つでも失敗の結果オブジェクトが含まれている場合は falseを返す。
クエリ結果が一つも格納されていない場合はtrueを返す。

戻り値:
このオブジェクトに格納されている結果が全て成功の場合は trueを返す。

getSpentTimeMillis

public long getSpentTimeMillis()
複数のクエリを実行するのに要した時間を取得する。
このオブジェクトに格納されている複数の結果オブジェクトの実行時間の合計を 算出して返す。
但し、setSpentTimeMillis(long)メソッドを使って処理時間を設定した 場合は、その値を返す。
時間の単位はミリ秒である。

戻り値:
複数のクエリを実行するのに要した時間。

setSpentTimeMillis

public void setSpentTimeMillis(long millis)
複数のクエリを全て実行するのに要した時間を設定する。
もし引数に負の値を設定した場合は、例外をスローする。

パラメータ:
millis - 複数のクエリを実行するのに要した時間[msec]。
例外:
java.lang.IllegalArgumentException - 引数が負値の場合。

resetSpentTimeMillis

public void resetSpentTimeMillis()
複数のクエリを全て実行するのに要した時間をリセットする。
このメソッドを実行することにより、過去にsetSpentTimeMillis(long) メソッドを使って設定した所要時間をリセットし、getSpentTimeMillis() メソッドがこのオブジェクトに格納されて結果オブジェクトの所要時間の合計を 返すようにする。


countResults

public int countResults()
このオブジェクトに格納されている結果オブジェクトの数を取得する。

戻り値:
このオブジェクトに格納されている結果オブジェクトの数。

getAllResults

public java.util.List<QueryResult> getAllResults()
このオブジェクトに格納されている全ての結果オブジェクトのリストを取得する。

戻り値:
結果オブジェクトを格納したリスト。

getFirstResult

public QueryResult getFirstResult()
このオブジェクトに格納されている最初の結果オブジェクトを取得する。
格納されている結果オブジェクトが存在しない場合はヌルを返す。

戻り値:
このオブジェクトに格納されている最初の結果オブジェクト。

getLastResult

public QueryResult getLastResult()
このオブジェクトに格納されている最後の結果オブジェクトを取得する。
格納されている結果オブジェクトが存在しない場合はヌルを返す。

戻り値:
このオブジェクトに格納されている最後の結果オブジェクト。

getResultsByConnectionId

public java.util.List<QueryResult> getResultsByConnectionId(java.lang.String connId)
指定されたコネクションIDに対する結果オブジェクトのリストを取得する。
該当する結果オブジェクトが存在しない場合は空のリストを返す。

パラメータ:
connId - コネクションID。
戻り値:
指定されたコネクションIDに対する結果オブジェクトのリスト。

getFirstResultByConnectionId

public QueryResult getFirstResultByConnectionId(java.lang.String connId)
指定されたコネクションIDに対する最初の結果オブジェクトを取得する。
該当する結果オブジェクトが存在しない場合はヌルを返す。

パラメータ:
connId - コネクションID。
戻り値:
指定されたコネクションIDに対する結果オブジェクト。

getLastResultByConnectionId

public QueryResult getLastResultByConnectionId(java.lang.String connId)
指定されたコネクションIDに対する結果オブジェクトのリストを取得する。
該当する結果オブジェクトが存在しない場合は空のリストを返す。

パラメータ:
connId - コネクションID。
戻り値:
指定されたコネクションIDに対する結果オブジェクト。

getResultsByQueryId

public java.util.List<QueryResult> getResultsByQueryId(java.lang.String queryId)
指定されたクエリIDに対する結果オブジェクトのリストを取得する。
該当する結果オブジェクトが存在しない場合は空のリストを返す。

パラメータ:
queryId - クエリID。
戻り値:
指定されたクエリIDに対する結果オブジェクトのリスト。

getFirstResultByQueryId

public QueryResult getFirstResultByQueryId(java.lang.String queryId)
指定されたクエリIDに対する最初の結果オブジェクトを取得する。
該当する結果オブジェクトが存在しない場合はヌルを返す。

パラメータ:
queryId - クエリID。
戻り値:
指定されたクエリIDに対する結果オブジェクト。

getLastResultByQueryId

public QueryResult getLastResultByQueryId(java.lang.String queryId)
指定されたクエリIDに対する結果オブジェクトのリストを取得する。
該当する結果オブジェクトが存在しない場合はヌルを返す。

パラメータ:
queryId - クエリID。
戻り値:
指定されたクエリIDに対する結果オブジェクト。

getResultByException

public QueryResult getResultByException(ts.util.ReasonedException exc)
指定された例外オブジェクトを持った結果オブジェクトのリストを取得する。
該当する結果オブジェクトが存在しない場合はヌルを返す。 また、引数の例外オブジェクトがヌルの場合もヌルを返す。

パラメータ:
exc - 理由付き例外オブジェクト。
戻り値:
引数の例外オブジェクトを持つ結果オブジェクト。


Copyright (C) SATOH Takayuki All Rights Reserved.