jp.ne.mki.wedge.run.common.optionaldata
クラス OptionalData

java.lang.Object
  jp.ne.mki.wedge.run.common.optionaldata.OptionalData

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

java.io.Serializable, OptionalDataConstants, ModuleConstants

public class OptionalData
extends java.lang.Object
implements OptionalDataConstants, java.io.Serializable

エンジン間で、バックグラウンドでデータを受けわたすための機能となります。
このクラスの１オブジェクトが、1データに相当します。

このクラスはname、data、target と三つのフィールドを保持しています。
nameは このデータのKEYとなる名称です。
OptionalDataMapからOptionalDataを取り出すときには、
このnameの値を指定する必要があります。
通常、アイテムの物理名がこの値として使用されます。


dataは実際に値を格納する領域となります。
通常は VectorやArrayList等の、Listオブジェクトが含まれており、
COLTEXTの場合は行数分データが格納され、
TEXTの場合は 1行のみデータが格納される形となります。


targetは送信先となります。
設定したOptionalDataをどのエンジンに送信するか…を指定します。
MODULE_RUNAPSERVERを指定した場合は RunApServerへ、
MODULE_RUNDBSERVERを指定した場合は RunDBServerへ向けて、
データを送信することとなります。
(RunDBServerに送信をするときは、RunApServerを経由するため、
RunApServer内でもそのデータを取得することが可能です。)
宛先を特定せず、全てのエンジンに受け渡したい場合は、
MODULE_ALLを指定することも可能です。

関連項目:

直列化された形式

フィールドの概要

インタフェース jp.ne.mki.wedge.run.common.optionaldata.OptionalDataConstants から継承されたフィールド

MODULE_ALL, REQUEST_BODY, REQUEST_HEADER

インタフェース jp.ne.mki.wedge.run.interfaces.ModuleConstants から継承されたフィールド

MODULE_DCSERVLET, MODULE_DCTEST, MODULE_DEBUGSERVER, MODULE_DOTNETCLIENT, MODULE_HTMLGATEWAY, MODULE_RUNAPSERVER, MODULE_RUNBATCHSERVER, MODULE_RUNCLIENT, MODULE_RUNDBSERVER, MODULE_RUNSERVLET, MODULE_TRANTEST, MODULE_UNKNOWN, MODULE_WEBSERVICE

コンストラクタの概要

OptionalData(java.lang.String name, java.lang.Object data, int target)
コンストラクタ

OptionalData(java.lang.String name, java.lang.Object data, java.lang.String target)
コンストラクタ

メソッドの概要

java.lang.Object	getData() このOptionalDataのデータを取得します
static java.lang.String	getModuleName(int value) 定数値から、送信先モジュールの文字列を取得します。
static int	getModuleValue(java.lang.String str) 文字列から、送信先モジュールの定数値を取得します。
java.lang.String	getName() このOptionalDataの名称を取得します。
int	getTarget() このOptionalDataの送信先を示すint値を取得します
java.lang.String	toString() name、data、targetの情報を表示します。

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

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

コンストラクタの詳細

OptionalData

public OptionalData(java.lang.String name,
                    java.lang.Object data,
                    int target)

コンストラクタ

パラメータ:

name - 名称

data - データ

target - 送信先対象エンジン(OptionalData.MODULE_**** を指定)

OptionalData

public OptionalData(java.lang.String name,
                    java.lang.Object data,
                    java.lang.String target)

コンストラクタ

パラメータ:

name - 名称

data - データ

target - 送信先対象エンジン(OptionalData.getModuleValueを使用して値に変換されます))

メソッドの詳細

getModuleValue

public static int getModuleValue(java.lang.String str)

文字列から、送信先モジュールの定数値を取得します。
文字列の "MODULE_"の部分を省略することもできます。

存在しない文字列が設定された場合は、MODULE_UNKNOWNの
値が返ってきます。

パラメータ:

_str - モジュール名(文字列)

戻り値:

モジュール名(定数値)

getModuleName

public static java.lang.String getModuleName(int value)

定数値から、送信先モジュールの文字列を取得します。

存在しない文字列が設定された場合は、nullが返ってきます。

パラメータ:

value - モジュール名(定数値)

戻り値:

モジュール名(文字列)

getName

public java.lang.String getName()

このOptionalDataの名称を取得します。

戻り値:

名称

getData

public java.lang.Object getData()

このOptionalDataのデータを取得します

戻り値:

データ

getTarget

public int getTarget()

このOptionalDataの送信先を示すint値を取得します

戻り値:

送信先

toString

public java.lang.String toString()

name、data、targetの情報を表示します。

オーバーライド:

クラス java.lang.Object 内の toString