ts.query
クラス QueryConfig

java.lang.Object
  上位を拡張 ts.query.QueryConfig
すべての実装されたインタフェース:
java.io.Serializable

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

クエリ設定クラス。
IQueryオブジェクトの処理に関する設定情報を格納するためのクラス。
引数なしのコンストラクタを使った場合は空の設定オブジェクトが作成され、getResource()メソッドで取得されるリソース・オブジェクトに設定情報を登録 して使用する。
引数にクエリIDを使用するコンストラクタを使った場合は、自動的にQueryEnvironmentConfigオブジェクトから取得したディレクトリ下からクエリIDを ファイル・タイトルにもつXMLファイル(.xml)又はJavaプロパティ・ファイル (.properties)をロードするので、その設定情報を使用する。
設定情報は、このオブジェクトを使用するクエリ・クラスによって異なるが、それに 依らない共通の設定情報として、

がある。 また、Queryオブジェクト固有の設定情報として、 がある。

バージョン:
$Id: QueryConfig.java,v 1.25 2012-03-14 07:49:20 tayu Exp $
作成者:
佐藤隆之
関連項目:
直列化された形式

入れ子のクラスの概要
static class QueryConfig.Error
          このクラスで発生しうるエラーを定義する列挙型。
 
コンストラクタの概要
QueryConfig()
          デフォルト・コンストラクタ。
QueryConfig(java.lang.String queryId)
          クエリIDを引数にとるコンストラクタ。
 
メソッドの概要
<T extends IQuery>
T
create()
          クエリ・オブジェクトを作成する。
<T extends IQuery>
T
create(IQueryTransaction tran)
          クエリ・オブジェクトを作成する。
protected static int executeCommand(java.lang.String[] args, QueryConfig config)
          クエリ設定ファイルのサンプルを出力するコマンドを実行する。
protected  java.util.List<java.lang.String> getExecutionIds()
          クエリ・オブジェクトが処理するIQueryExecutionの実行IDのリストを 取得する。
protected  java.lang.String getQueryClass()
          このオブジェクトから作成されるクエリ・オブジェクトのクラス名を取得する。
 java.lang.String getQueryId()
          クエリIDを取得する。
protected  ts.util.resource.Resource getResource()
          クエリ設定を保持するリソース・オブジェクトを取得する。
protected  ts.util.resource.Resource loadResource()
          クエリ設定ファイルをロードしたリソース・オブジェクトを作成する。
protected  ts.util.AbstractTypedGetter<java.lang.String,java.lang.String> newTypedGetter()
          設定情報を型変換して取得するためのTypedGetterオブジェクトを作成 する。
protected  void outputSampleProp(java.io.PrintWriter pw)
          クエリ設定ファイルのJavaプロパティ形式のサンプルをPrintWriter オブジェクトに出力する。
protected  void outputSamplePropEntries(java.io.PrintWriter pw)
          クエリ設定ファイルのプロパティ・エントリのサンプルをPrintWriter オブジェクトに出力する。
protected  void outputSampleXml(java.io.PrintWriter pw, java.lang.String encoding)
          クエリ設定ファイルのXML形式のサンプルをPrintWriterオブジェクトに 出力する。
protected  void outputSampleXmlEntries(java.io.PrintWriter pw)
          クエリ設定ファイルのXMLエントリのサンプルをPrintWriterオブジェクト に出力する。
protected  ts.util.AbstractTypedGetter<java.lang.String,java.lang.String> typedGetter()
          設定情報を型変換して取得するためのTypedGetterオブジェクトを取得 する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

QueryConfig

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


QueryConfig

public QueryConfig(java.lang.String queryId)
クエリIDを引数にとるコンストラクタ。

パラメータ:
queryId - クエリID。
例外:
ts.util.ReasonedRuntimeException - 引数がヌル又は空文字列の場合。
メソッドの詳細

getQueryId

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

戻り値:
クエリID。

loadResource

protected ts.util.resource.Resource loadResource()
                                          throws ts.util.ReasonedRuntimeException
クエリ設定ファイルをロードしたリソース・オブジェクトを作成する。

戻り値:
クエリ設定ファイルをロードしたリソース・オブジェクト。
例外:
ts.util.ReasonedRuntimeException - クエリ設定ファイルのロードに失敗した場合。

newTypedGetter

protected ts.util.AbstractTypedGetter<java.lang.String,java.lang.String> newTypedGetter()
設定情報を型変換して取得するためのTypedGetterオブジェクトを作成 する。

戻り値:
TypedGetterオブジェクト。

getResource

protected ts.util.resource.Resource getResource()
クエリ設定を保持するリソース・オブジェクトを取得する。

戻り値:
クエリ設定を保持するリソース・オブジェクト。

typedGetter

protected ts.util.AbstractTypedGetter<java.lang.String,java.lang.String> typedGetter()
設定情報を型変換して取得するためのTypedGetterオブジェクトを取得 する。

戻り値:
TypedGetterオブジェクト。

create

public <T extends IQuery> T create()
                        throws ts.util.ReasonedException,
                               ts.util.ReasonedRuntimeException
クエリ・オブジェクトを作成する。
このオブジェクトが保持するクエリ設定を使って、IQueryの派生クラスの インスタンスを作成する。 派生クラスの名前は、クエリ設定 ts-query.query.classに指定された クラス名が使用される。

戻り値:
クエリ・オブジェクト。
例外:
ts.util.ReasonedException - クエリ・オブジェクトの作成に失敗した場合。
ts.util.ReasonedRuntimeException - クエリ設定が不正だった場合。

create

public <T extends IQuery> T create(IQueryTransaction tran)
                        throws ts.util.ReasonedException,
                               ts.util.ReasonedRuntimeException
クエリ・オブジェクトを作成する。
このオブジェクトが保持するクエリ設定と引数のトランザクション・オブジェクト を使って、IQueryの派生クラスのインスタンスを作成する。 派生クラスの名前は、クエリ設定 ts-query.query.classに指定された クラス名が使用される。
引数のトランザクション・オブジェクトからは、そのIQueryConnection オブジェクトやIQueryHistoryオブジェクトを使用する。

パラメータ:
tran - クエリ・トランザクション・オブジェクト。
戻り値:
クエリ・オブジェクト。
例外:
ts.util.ReasonedException - クエリ・オブジェクトの作成に失敗した場合。
ts.util.ReasonedRuntimeException - クエリ設定が不正だった場合。

getQueryClass

protected java.lang.String getQueryClass()
このオブジェクトから作成されるクエリ・オブジェクトのクラス名を取得する。

戻り値:
クエリ・クラスの名前。

getExecutionIds

protected java.util.List<java.lang.String> getExecutionIds()
クエリ・オブジェクトが処理するIQueryExecutionの実行IDのリストを 取得する。

戻り値:
実行IDのリスト。

outputSampleXml

protected void outputSampleXml(java.io.PrintWriter pw,
                               java.lang.String encoding)
                        throws java.io.IOException
クエリ設定ファイルのXML形式のサンプルをPrintWriterオブジェクトに 出力する。

パラメータ:
pw - PrintWriterオブジェクト。
例外:
java.io.IOException - 出力に失敗した場合。

outputSampleXmlEntries

protected void outputSampleXmlEntries(java.io.PrintWriter pw)
                               throws java.io.IOException
クエリ設定ファイルのXMLエントリのサンプルをPrintWriterオブジェクト に出力する。

パラメータ:
pw - PrintWriterオブジェクト。
例外:
java.io.IOException - 出力に失敗した場合。

outputSampleProp

protected void outputSampleProp(java.io.PrintWriter pw)
                         throws java.io.IOException
クエリ設定ファイルのJavaプロパティ形式のサンプルをPrintWriter オブジェクトに出力する。

パラメータ:
pw - PrintWriterオブジェクト。
例外:
java.io.IOException - 出力に失敗した場合。

outputSamplePropEntries

protected void outputSamplePropEntries(java.io.PrintWriter pw)
                                throws java.io.IOException
クエリ設定ファイルのプロパティ・エントリのサンプルをPrintWriter オブジェクトに出力する。

パラメータ:
pw - PrintWriterオブジェクト。
例外:
java.io.IOException - 出力に失敗した場合。

executeCommand

protected static int executeCommand(java.lang.String[] args,
                                    QueryConfig config)
クエリ設定ファイルのサンプルを出力するコマンドを実行する。
コマンドライン引数の配列の構成は以下の通りである:
  1. args[0] - コマンド名
  2. args[1] - 出力ファイル・パス
  3. args[2] - 出力ファイル形式("xml":XML形式、"prop":Javaプロパティ形式、但し大文字小文字は区別しない)
  4. args[3] - 出力ファイルの文字エンコーディング
また、終了コードは以下の値をとりうる:

パラメータ:
args - コマンドライン引数の配列。
config - クエリ設定オブジェクト。
戻り値:
コマンドの終了コード。


Copyright (C) SATOH Takayuki All Rights Reserved.