14.1　提供するクラス

XMAP3/Web for Cosminexusでは，論理マップ，動的変更テーブルなどをJavaで扱えるようにするためにXML文書を生成します。このため，XMAP3/Web for Cosminexusでは，各XML文書のオブジェクトに対応するクラスを提供しています。

XMAP3/Web for Cosminexusが提供するクラスを使用する場合は，次に示すパッケージを使用してください。

[jp.co.Hitachi.soft.XMAP3.server]

XMAP3/Web for Cosminexusが提供するクラスの一覧を次の表に示します。

表14‒1　XMAP3/Web for Cosminexusが提供するクラス一覧
クラス	クラス名	概要
PropertyValue	環境管理用クラス	環境管理ファイルのオブジェクトを構築します。
LogicalMap^※	入力出力データ用クラス	入力／出力データ用XML文書のオブジェクトを構築します。
ConstValue^※	定数用クラス	定数用XML文書のオブジェクトを構築します。
ModTbl	動的変更用クラス	動的変更用XML文書のオブジェクトを構築します。
ComTbl	通信制御用クラス	通信制御用XML文書のオブジェクトを構築します。
Filler	桁寄せクラス	桁寄せを指定する際に指定する定数オブジェクトです。

注※

LogicalMapクラスまたはConstValueクラスで繰り返し項目にアクセスする場合，繰り返し項目のインデックスを指定するときは0から指定してください。

フレーム内およびフレーム外の繰り返しフィールドにアクセスする場合について次に説明します。

フレーム内の繰り返しフィールドにアクセスする場合

　フレームを意識しないでフィールド単位にアクセスしてください。

フレーム外の繰り返しフィールドにアクセスする場合

　フィールド単位にアクセスしてください。

Stringおよびbyte[ ]を指定する場合には，ヌルオブジェクトを指定しないでください。ヌルオブジェクトを指定した場合，XmapRuntimeExceptionをスローします。

各クラスで指定できるデータ（数値）の範囲を次に示します。範囲外の数値を指定した場合は，XmapExceptionをスローします。

setterでデータを設定する場合，設定元のデータのデータ長が，設定先のデータ長より長いとき，設定先のデータ長だけデータを設定します。

XMAP3/Web for Cosminexusが提供する例外クラスの一覧を次の表に示します。

表14‒2　XMAP3/Web for Cosminexusが提供する例外クラス一覧
例外クラス	概要
XmapException	XMAP3が提供するメソッドのパラメタが正しくないとき，またはデータ定義XMLの定義が正しくないときに発生する例外クラスです。この例外が発生した場合は，APおよびデータ定義XMLを見直す必要があります。
XmapEnvironmentException	ユーザのXMAP3の実行環境が正しくない場合に発生する例外クラスです。この例外が発生した場合，ThrowableクラスのgetCause()メソッドで例外の詳細を調べて，例外に対処する必要があります。
XmapRuntimeException	業務を実行中にXMAP3が提供するメソッドの延長で発生する例外です。この例外が発生した場合，ThrowableクラスのgetCause()メソッドで例外の詳細を調べて，例外に対処する必要があります。

XMAP3/Web for Cosminexusが提供する各クラスのメソッドでは，ログを出力します。

この章では，XMAP3/Web for Cosminexusが提供するクラスが提供するメソッドについて説明します。