変数とインポートした Java クラス

HATS 変数

HATS には、主に、グローバル変数とマクロ変数の 2 つのタイプの変数があります。ここでは、これらの変数の相違点の概要について説明します。

グローバル変数

グローバル変数は、HATS Toolkit で作成される変数であり、HATS プロジェクトによって 使用されます。グローバル変数は、マクロ・ スクリプトの外部に保管されます。これらの変数は、HATS ランタイムによって 保守および更新されます。グローバル変数には、次の 2 つのタイプがあります。

ローカル
ローカル・グローバル変数は、HATS プロジェクト内で 作成される変数であり、そのプロジェクトからのみ可視になります。
共用
共用グローバル変数は、.ear ファイルのすべての HATS Web アプリケーション、または同じ リッチ・クライアント 環境で実行されているすべての HATS リッチ・クライアント アプリケーションから可視であり、使用できる変数です。

グローバル変数がローカルであるか共用であるかは、グローバル変数の作成時に GUI の「共用」チェック・ボックスにチェック・マークが付いているか、 あるいは set、prompt、または extract タグの 共用属性の値が HATS .hma ソース・ファイルで yes と no のどちらに 指定されているかによって決まります。

マクロ変数

マクロ変数はグローバル変数と異なり、HATS の .hma ソース・ファイル内のマクロ内部で使用および保管されます。マクロ変数は、マクロ・エディターを使用して作成できます。VME を使用してマクロ変数を作成するには、「変数およびタイプ」タブを参照してください。また、AME を使用する場合は、変数タブを参照してください。 マクロ変数は、マクロ・エンジンによって作成、保管、および使用され、 マクロ・スクリプトにリストされています。

グローバル変数用の HATS プロンプトおよび抽出を使用する HATS マクロ (.hma) ファイルのソースでは、プロンプトおよび抽出は、ファイル内のマクロ・スクリプト構文の前に現れます。マクロ変数を含むマクロ・スクリプトは、開始タグ <HAScript> および終了タグ </HAScript> に囲まれています。

マクロ変数とインポート済みタイプの概要

マクロ変数は、マクロにプログラミングで高度な動作を加えるために役立ちます。 変数を使用すれば、値の格納、結果の保存、カウントの保持、 テキスト・ストリングの保存、結果の記憶など、プログラミングで 可能なあらゆることを実行できます。

標準データ・タイプ (string、integer、double、boolean、および field) のいずれかに 属する変数を作成できます。

また、Java™ クラスを表すインポート済みタイプに属する変数も作成できます。その後クラスのインスタンスを作成し、インスタンスに対してメソッドを呼び出すことが できます。この機能を利用すれば、Java ランタイム環境 (JRE) ライブラリー、自分でインプリメントしたクラスやライブラリー、他のソースから提供された Java のクラスやライブラリーなどの、各種 Java クラス・ライブラリーに備わっている豊富な機能を使用できるようになります。

拡張マクロ形式が必要

変数を使用するには、マクロに対して拡張マクロ形式を使用する必要が あります (基本マクロ形式と拡張マクロ形式を参照)。このため、基本マクロ形式のマクロに変数を追加するには、 マクロを拡張マクロ形式に変換するかどうか決定する必要があります。基本マクロ形式の古いマクロが多数のユーザーに使用されていて、問題なく機能している場合は、マクロを現状のままにしておくこともできます。

ただし、記録済みマクロはすべて基本マクロ形式で記録されていることに 注意してください。つまり、マクロを最近記録し、そのマクロの改良を始めようとしている場合は、 単に拡張マクロ形式への切り替えをまだ済ませていないだけかもしれません。

マクロ・エディターは、基本マクロ形式のままのマクロに変数を定義しようとすると、 ポップアップ・ウィンドウに次のメッセージを表示して、これら両方の 状況に対応します。

図 23. 注意喚起メッセージ
高度なマクロ機能を使用しようとしています。処理の継続を選択すると、
マクロは自動的に拡張マクロ形式に変換されます。
継続しますか?

作成するマクロで変数を使用する予定にしている場合は「はい」を クリックし、基本マクロ形式のマクロを変換したくない場合は「いいえ」をクリックします。

変数の有効範囲

それぞれの変数のスコープは、変数を作成する対象のマクロに関してグローバル です。つまり、マクロにある任意のマクロ画面から、マクロの変数すべてに アクセスできます。マクロ画面内のアクションまたは記述子が その変数にアクセスするには、単に変数名を使用するだけです。

例えば、$intPartsComplete$ という名前の変数を 0 に初期化したとします。マクロの進行に伴って、次のように変数を使用できます。

  1. ScreenC がタスクの部分 1 を完了し、変数更新アクションを 使用して $intPartsComplete$ を増分する。
  2. ScreenG がタスクの部分 2 を完了し、変数更新アクションを 使用して $intPartsComplete$ を増分する。
  3. ScreenM の条件アクションが、部分 1 と部分 2 のどちらが現時点で 完了しているかテストする。結果に応じて、マクロは ScreenR または ScreenS を次に処理するマクロ画面 として予期する。
  4. ScreenS がタスクの部分 3 を完了し、変数更新アクションを 使用して $intPartsComplete$ を増分する。

この例では、いくつかの異なるマクロ画面のアクションが、 変数 $intPartsComplete$ の読み取りまたは書き込みを実行できます。

変数の作成

ソース表示で、<create> エレメントを使用して変数を作成します。 マクロ・スクリプト内の変数すべてを含む収容エレメント <vars> があり、 それぞれの変数ごとに <create> エレメントがあります。図 24 に、5 つの <create> エレメント を含む <vars> エレメントを示します。

図 24. サンプル <vars> エレメント
<vars>
   <create name="$strAccountName$" type="string" value="" />
   <create name="$intAmount$" type="integer" value="0" />
   <create name="$dblDistance$" type="double" value="0.0" />
   <create name="$boolSignedUp$" type="boolean" value="false" />
   <create name="$fldFunction$" type="field" />
</vars>

図 24 の <vars> エレメントは、 それぞれの標準データ・タイプ (string、integer、double、boolean、 および field) から変数を 1 つ作成します。

変数の作成 (<create> エレメント) は、すべて <vars> エレメントの 中に置く必要があります。<vars> エレメント自体は、<import> エレメントがあればその後 (次の セクションを参照)、かつ最初のマクロ画面 (<screen> エレメント) の 前に置く必要があります。

Java クラスのインポート済みタイプの作成

ソース表示で、<type> エレメントを使用してインポート済みタイプを作成します。 マクロ・スクリプト内のインポート済みタイプすべてを含む収容エレメント <import> があり、 それぞれのインポート済みタイプごとに <type> エレメントがあります。図 25 は、インポート済みタイプ を宣言する <import> エレメント、およびインポート済みタイプに 属する変数を作成して初期化する後続の <vars> エレメントを示しています。

図 25. インポート済みタイプとそのタイプの変数
<import>
   <type class="java.util.Hashtable" name="Hashtable" />
</import>

<vars>
   <create name=$ht$ type="Hashtable" value="$new Hashtable(40)$" />
 </vars>

上の図で、<import> エレメントには <type> エレメントが 1 つ含まれ、 このエレメントには class 属性 (完全修飾クラス 名 java.util.Hashtable を指定) と name 属性 (短縮名 Hashtable を指定) があります。<vars> エレメントには <create> エレメントが 1 つ含まれ、 このエレメントは名前 ($ht$)、タイプ (Hashtable)、 および初期値 (ここでは null ではなく、クラスのインスタンス を戻すコンストラクター $new Hashtable(40)$ の呼び出し) を 通常どおり指定します。

ソース表示を使用している場合は、インポート済みタイプ (<type> エレメント) をすべて <import> エレメント内に入れる必要があります。<import> エレメント自体は、<HAScript> エレメントの内 (<HAScript> エレメントを参照) かつ <vars> エレメントの前に置く必要があります。

一般的な問題

Java ライブラリー またはクラスの配置

マクロの再生中に、マクロ・ランタイムが Java メソッドの呼び出しを処理する場合は、メソッドが所属するクラスに使用可能なすべての Java ライブラリー・ファイルおよびクラス・ファイルを検索します。この検索は、クラスを検出するまで停止しません。

Java ライブラリーまたはクラスの配置作業は、クラスを含むライブラリー・ ファイルまたはクラス・ファイルを、マクロ・ランタイムがマクロの再生中に クラスを検出できる場所に配置する作業からなります。以下の Java クラスは自動的に利用可能となるため、配置する必要はありません。

マクロ・スクリプトによって呼び出されるメソッドを含む他のすべての Java クラスは、マクロ・ランタイムが検出できる場所に配置する 必要があります。環境に応じて、クラス・ファイルとして、または Java クラスを 含むライブラリーとして Java クラスを配置できます。

WebSphere® Application Server のランタイム環境 (ポータルではなく) で Java クラスを使用する場合は、マクロ・ランタイムは Java EE エンタープライズ・アプリケーション Application (.ear) ファイルにパッケージ化されていることに注意してください。Java クラスが HATS Web プロジェクトにパッケージ化されている場合は、Web アーカイブ (WAR) クラス・ローダーのポリシーをアプリケーションの単一クラス・ローダーに更新して、マクロ実行時にマクロ・ランタイムが Java クラスに確実にアクセスできるようにする必要があります。このように構成しないと、マクロが Java クラスを呼び出したときに、ClassNotFoundExceptions が発生します。クラス・ローダーのポリシーの構成方法を確認するには、ご使用のバージョンの WebSphere Application Server の資料でアプリケーション・クラス・ローダーの構成に関する説明を参照してください。

変数名とタイプ名

変数名の規則は次のとおりです。

タイプ名の規則は次のとおりです。

マクロ間での変数の転送

1 つのマクロを別のマクロに「チェーニング」する (戻りのない呼び出し) PlayMacro アクションの場合は、 呼び出し側マクロのすべての変数とその値をターゲット・マクロに転送できます。ターゲット・マクロは、自身の変数と転送された変数の両方に アクセスできます (PlayMacro アクション (<playmacro> エレメント)を参照)。

フィールド変数

フィールド変数は、ストリング変数の一種です。フィールド変数は、 ストリング変数と同様にストリングを格納し、ストリング変数が有効である すべてのコンテキストでフィールド変数を使用できます。

ただし、フィールド変数にストリングが格納される方法について、 フィールド変数とストリング変数は異なっています。フィールド変数に格納されるストリングは、常に、マクロ・ランタイムが現行ホスト端末上の 3270 フィールドまたは 5250 フィールドから読み取ったストリングになります。マクロ・ランタイムが このストリングを 3270 または 5250 フィールドから読み取るようにするには、 次の項目を指定して変数更新アクションを作成する必要があります。

  1. フィールド変数の名前 ($fldFilename$ など)。
  2. 位置ストリング ('5,11' のように、コンマで区切った 1 対の 整数を含むストリング)。

マクロ・ランタイムは、変数更新アクションを実行するときに 次のステップを行います。

  1. ホスト端末上で、位置ストリングに指定されている行と列の位置を検出する。
  2. その行と列の値が位置指定している 3270 または 5250 フィールド を検索する。
  3. フィールドの内容全体を読み取る。
  4. フィールドの内容全体をストリングとしてフィールド変数に格納する。

詳しくは、フィールド変数に対する変数更新アクションを参照してください。

変数の使用

マクロ・ランタイムは、マクロの再生を開始するとき、マクロ画面を 処理する前に変数に初期値を割り当てます。以下のセクションでは、標準変数タイプおよびインポート済み変数タイプの両方について、これらの初期値の使用法を説明します。

標準タイプに属する変数の使用

変数が保持する値の使用

標準タイプ (string、integer、double、boolean) に属する変数は、 同じタイプの即時値 ('Elm Street'、10、4.6e-2、true など) とほぼ同じ方法で使用できます。

ただし、特定のコンテキストでは変数を使用できません。AME では、次のコンテキストで変数を使用できません。

ソース表示では、次のコンテキストで変数を使用できません。

標準タイプに属する変数への値の書き込み

標準タイプに属する変数には、次の方法で値を書き込むことができます。

制限

標準タイプの変数に、次の値のいずれかを割り当てることはできません。

標準タイプの変数に Java オブジェクトを書き込む

標準タイプの変数に Java オブジェクトを書き込むと、マクロ・ランタイムは インポート済みタイプの toString() メソッドを呼び出してから、 結果ストリングを変数に割り当てることを試みます。

インポート済みタイプに属する変数の使用

変数が保持する値の使用

インポート済みタイプに属する変数に格納されている値は、 次のように使用できます。

制限

次のタイプのデータは、インポート済みタイプの変数に割り当てることはできません。

インポート済みタイプの変数にマクロがこれらの無効なタイプの 1 つの値を割り当てようとすると、マクロ・ランタイムはランタイム・エラーを生成して、マクロを停止します。

インポート済みタイプに属する変数への書き込み

インポート済みタイプの変数には、次の方法で値を書き込むことができます。

インポート済みタイプに属する変数には、次のタイプの変数を割り当てることができます。

同じインポート済みタイプの変数の比較

同じインポート済みタイプの 2 つの変数を比較する条件式 (例えば、 条件アクションの「条件」フィールド内) の中では、 変数自体を使用するのでなく、基礎クラスにある比較メソッド (equals() など) を インプリメントする必要があります。例えば、次のとおりです。

$htUserData.equals($htPortData$)$

代わりに、変数自体を比較すると (例: $htUserData$ == $htPortData$)、次のようになります。

  1. マクロ・ランタイムは、それぞれの変数ごとに、基礎 Java クラス の toString() メソッドを呼び出し、ストリングの結果を得る。
  2. マクロ・ランタイムは、2 つのストリングの結果を比較し、 ブールの結果を得る。
  3. マクロ・ランタイムは、条件の結果をステップ 2 で得られたブールの結果に 設定する。

これにより得られる結果は、2 つの変数の比較結果としては正しくない 可能性があります。

Java メソッドの呼び出し

メソッド呼び出しを使用できる個所

メソッドから戻される値が有効であるすべてのコンテキストで、 メソッドを呼び出すことができます。例えば次のように、 入力アクションの中で行の値をメソッドから戻される整数値に設定できます。

$importedVar.calculateRow()$

また、メソッドの戻り変数が必要ない場合や、メソッドに戻り値が ない (void) 場合は、実行アクションを使用して メソッドを呼び出すこともできます (実行アクション (<perform> エレメント)を参照)。

メソッド呼び出しの構文

インポートしたクラスに属するメソッドを呼び出すには、Java で使用する ものと同じ構文を使用します。ただし、その構文に加え、変数の場合と同じように、 メソッド呼び出しをドル記号 ($) で囲む必要があります。例:

$new FileInputStream('filename')$
$fis.read()$ 

メソッドにパラメーターとして渡す即時ストリング値 ('Elm Street'、 または上記の最初の例での 'filename' など) は、 通常どおり単一引用符で囲む必要があります (拡張マクロ形式の規則 を参照)。

マクロ・ランタイムが呼び出し先メソッドを検索する方法

メソッド呼び出し ($prp.get('Group Name')$ など) をマクロ・スクリプトに追加する際に、マクロ・エディターは、呼び出し先メソッドまたはコンストラクターが、変数の属するクラスに存在するかどうかを検査しません。その検査は、呼び出しが行われたときにマクロ・ランタイムによって 行われます。

メソッドは、基礎 Java クラスの public メソッド でなければなりません。

マクロ・ランタイムは、ユーザーが呼び出したメソッドに一致するメソッドが あるかどうか Java クラスを検索する際に、表 12 に示すように マクロのデータ・タイプ (boolean、integer、string、field、double、 インポート済みタイプ) を Java データ・タイプにマップします。

表 12. マクロ・ランタイムがマクロのデータ・タイプを Java データ・タイプにマップする方法
メソッド・パラメーターが以下のマクロ・データ・タイプに属する場合: マクロ・ランタイムは以下の Java データ・タイプのパラメーターを 持つ Java メソッドを検索する:
boolean boolean
integer int
string String
field String
double double
インポート済みタイプ インポート済みタイプの基礎クラス

マクロ・ランタイムは、呼び出し先メソッドを次のように検索します。

  1. マクロ・ランタイムは、インポート済みタイプの定義に指定されている クラスを検索する (java.util.Properties など)。
  2. マクロ・ランタイムは、そのクラス内で呼び出し先メソッドと同じ メソッド・シグニチャー (名前、パラメーター数、およびパラメーターの タイプ) を持つメソッドを検索する。
  3. 検索が成功した場合、マクロ・ランタイムはメソッドを呼び出す。
  4. 検索が失敗した場合、マクロ・ランタイムはそのクラス内で、 呼び出し先メソッドと同じ名前とパラメーター数 (パラメーターのタイプは無視) を 持つメソッドを検索する。
    1. マクロ・ランタイムが該当するメソッドを検出した場合は、 指定されたパラメーターを使用してメソッドを呼び出す。
    2. 呼び出しがエラーを出さずに戻った場合、マクロ・ランタイムは 正しいメソッドを呼び出したものと想定する。
    3. 呼び出しがエラーを出して戻った場合、マクロ・ランタイムは 別のメソッドを検索する。
    4. 同じ名前とパラメーター数を持つメソッドをすべて試すまで、 検索が継続される。どれも成功しなかった場合、マクロ・ランタイムは ランタイム・エラーを生成する。

Macro Utility Libraries (HML ライブラリー)

Host On-Demand Macro Utility Libraries (HML ライブラリー) は、HATS コードと ともにパッケージされているユーティリティー・ライブラリーです。 次の作業を行わずに、これらのライブラリーのいずれかからメソッドを 呼び出すことができます。

実際には、HML Java ライブラリーに含まれているクラスの インポート、HML クラスに属する変数の作成、または HML オブジェクトの作成は 許可されていません。

それは、マクロの再生を開始すると行われる初期化中に、マクロ・ランタイムは 以下の作業を行うためです。

次の表は、HML 変数ごとの変数名および基礎クラスのメソッドのタイプを示します。

表 13. HML 変数
HML 変数: メソッドの説明:
$HMLFormatUtil$ ストリングをフォーマット設定するためのメソッド。
$HMLPSUtil$ セッション・ウィンドウの表示スペースにアクセスするメソッド。
$HMLSessionUtil$ セッション値を戻すメソッド。
$HMLSQLUtil$ 最新の SQLQuery アクションの結果に関する情報を戻すメソッド。

HML ライブラリーに属するメソッドの呼び出し

HML ライブラリーに属するメソッドを呼び出すには、変数名、メソッド名、および 入力パラメーターを通常の方法で指定します。

図 26. HML メソッドを呼び出す場合の例
$HMLFormatUtil.numberToString(1.44)$
$HMLPSUtil.getCursorPos()$
$HMLSessionUtil.getHost()$

HML で始まる変数名は予約済み

通常の変数と HML 変数を混合しないようにするために、HML で 始まる変数名は予約されています。HML で始まる変数を 作成しようとすると、Host On-Demand はエラー・メッセージを生成します。

$HMLFormatUtil$

$HMLFormatUtil$ で呼び出されるメソッドは、メソッドをフォーマット設定します。 表 14 は、これらのメソッドの 要約を示します。

表 14. $HMLFormatUtil$ のメソッドの要約
METHOD SUMMARY: $HMLFormatUtil$
String
numberToString(Object obj)
数値を、現在構成されているロケールに従ってフォーマット設定した ストリングに変換します。入力パラメーターのタイプは、整数または 倍精度です。
int または double
stringToNumber(String str)
ロケール形式の数値ストリング ('1111.56'、'1,111.56'、または '1111,56' など) を数値に変換します。戻される数値のタイプは、 入力ストリングに応じて、整数または倍精度になります。

数値と現行ロケールの形式との相互変換

ロケールは、特定の各国語と地域に関連するフォーマット設定の 規則セットです。例えば、クライアント・ワークステーションを構成する ロケールに応じて、1111.22 などの 10 進値は、次のストリングで表すことができます。

'1111.22'
'1,111.22'
'1111,22'

別の例では、-78 などの負の数値は次のように表すことができます。

'-78'
'78-'

メソッド numberToString() および stringToNumber() は、 数値 (1111.22 などのタイプが整数または倍精度の変数または即時値) と 現行ロケールでの表記 ('1111.22'、'1,111.22'、または '1111,22' などのストリング) の間の変換を実行します。

メソッドの詳細

numberToString()
public String numberToString(Object obj)

このメソッドは、数値 (整数または倍精度) を、現在構成されている ロケールに従ってフォーマット設定したストリングに変換します。 入力パラメーターのタイプは、整数または 倍精度です。

このメソッドは、推奨されないスタンドアロン・メソッド $FormatNumberToString()$ を置換します。

図 27. numberToString() の例
<input value="$HMLFormatUtil.numberToString(1111.44)$"
          row="20" col="16" movecursor="true"
          xlatehostkeys="true" encrypted="false" />
stringToNumber()
public int stringToNumber(String str)
public double stringToNumber(String str)

このメソッドは、現在構成されているロケールに従ってフォーマット設定されている 数値ストリングを数値に変換します。戻される数値のタイプは、 入力ストリングに応じて、整数または倍精度になります。

このメソッドは、推奨されないスタンドアロン・メソッド $FormatStringToNumber()$ を置換します。

図 28. stringToNumber() の例
<value="’1111.33’" />
<extract name="'Extract'" planetype="TEXT_PLANE"
         srow="1" scol="1"
         erow="1" ecol="10" unwrap="false"
         assigntovar="$value$" />
<if condition="$HMLFormatUtil.stringToNumber($value$)$ < 0 "
   ...
</if>

$HMLPSUtil$

$HMLPSUtil$ で呼び出されるメソッドは、セッション・ウィンドウの表示スペースに 影響を与えるか、またはセッション・ウィンドウの表示スペースに関する 情報を戻します。表 15 は、これらのメソッドの 要約を示します。

表 15. $HMLPSUtil$ のメソッドの要約
METHOD SUMMARY: $HMLPSUtil$
int
convertPosToCol(int pos)
表示スペースでの指定の位置のカラム番号を戻します。
int
convertPosToRow(int Pos)
表示スペースでの指定の位置の行番号を戻します。
void
enableRoundTrip(boolean flag)
双方向言語の場合は、前に双方向文字が付いた数表示が、場所と 数表示を交換するかどうかを決定します。
int
getCursorCol()
表示スペースでのテキスト・カーソルのカラム番号を戻します。
int
getCursorPos()
表示スペースでのテキスト・カーソルの位置を戻します。
int
getCursorRow()
表示スペースでのテキスト・カーソルの行番号を戻します。
int
getSize()
表示スペースのサイズ (表示スペースでの文字の位置の数) を戻します。
int
getSizeCols()
表示スペースのカラム数を戻します。
int
getSizeRows()
表示スペースの行数を戻します。
String
getString(int pos, int len)
表示スペースでの指定位置で始まり、指定された長さで続く テキスト・ストリングを戻します。
int
searchString(String str)
指定されたストリングの表示スペースでの位置を戻します (指定されたストリングが表示スペースにない場合は 0)。

表示スペース

表示スペースは、セッション・ウィンドウでの行とカラムの各位置の エレメントを含む (ただし、オペレーター情報域に使用されるセッション・ ウィンドウの最後の行を含まない) データ構造です。表示スペースのサイズは、 セッション・ウィンドウのサイズによって異なります。例えば、セッション・ウィンドウに 24 の行と 80 のカラムが ある場合は、表示スペースのサイズは 24 * 80 = 1920 です。

表示スペースでのエレメントの位置は、セッション・ウィンドウでの 行とカラムの位置に直列的に (左から右、上から下) 対応します。 例えば、セッション・ウィンドウに 80 の行と 25 の カラムがある場合は、行とカラムの位置は、図 29 で示すようになります。

図 29. 表示スペースでの行とカラムの場所の対応
     Row of    Column of  Corresponds to
     Session   Session    element at this
     Window:   Window:    position in PS:
         1          1             1
         1          2             2
         1          3             3
      ...
         1         80            80
         2          1            81
         2          2            82
         2          3            83
      ...
        24         79          1919
        24         80          1920

Host On-Demand は、表示スペースを使用して、セッション・ウィンドウで 表示される文字を格納します。表示スペースの各エレメントを使用して、 文字 (および輝度などのその文字に関する情報) を格納します。例えば、セッション・ウィンドウの行 1 とカラム 1 にストリング Message が表示される場合、その位置に対応する行とカラムは、図 30 で示すようになります。

図 30. 行 1、カラム 1 に 'Message' が表示されるときのレイアウト
     Row of    Column of  Corresponds    Character
     Session   Session    to element     stored in
     Window:   Window:    at this pos-   this element:
                          ition in PS:
         1          1          1          M
         1          2          2          e
         1          3          3          s
         1          4          4          s
         1          5          5          a
         1          6          6          g
         1          7          7          e

通常は使用する必要はありませんが、表 16 は、 さまざまな値を計算するための公式を示します。これらの公式で使用される 記号の意味は、次のとおりです。

表 16. 表示スペースに関連する値を計算するための公式
値: 計算の公式:
PS のサイズ
 NUMROWS * NUMCOLS

    Example:
    24 * 80 = 1920
row
 (pos + NUMCOLS - 1) / NUMCOLS

    Example:
    (81 + 80 - 1) / 80 = 2 
col
 pos - ((row - 1) * NUMCOLS)

    Example:
    1920 - ((24 - 1) * 80) = 80
pos
 ((row - 1) * NUMCOLS) + col

    Example:
    ((24 - 1) * 80) + 1 = 1641

メソッドの詳細

convertPosToCol()
public int convertPosToCol(int pos)

このメソッドは、表示スペースでの指定の位置に関連するカラム番号を 戻します。

図 31. convertPosToCol() の例
<varupdate name="$cursor_col$ value="$HMLPSUtil.convertPosToCol($HMLPSUtil.getCursorPos()$) $" />
convertPosToRow()
public int convertPosToRow(int pos)

このメソッドは、表示スペースでの指定の位置に関連する行番号を 戻します。

図 32. convertPosToRow() の例
<varupdate name="$cursor_row$" value=$HMLPSUtil.convertPosToRow($HMLPSUtil.getCursorPos()$)$" />
enableRoundTrip()
public void enableRoundTrip(boolean flag)

このメソッドは、双方向言語 (アラビア語およびヘブライ語) 専用です。 A、B、および C が双方向文字であると 仮定します。 通常、ストリングに一連の双方向文字とその後に一連の数表示 (例えば、ABC 123) が含まれている場合は、ストリング全体が 保管され、Host On-Demand クライアントは、双方向文字の位置と数表示を 交換します。例えば、表示スペースからストリング ABC 123 を 読み取り、ストリングを変数に格納して、次に変数の値を表示スペースに 書き込む場合、Host On-Demand クライアントは、通常は 123 ABC を 表示スペースに書き込みます。

この強制反転の技法をオフにするには、true を指定して enableRoundTrip() を呼び出します。この強制反転の技法を 復元するには、false を指定して enableRoundTrip() を呼び出します。

図 33. enableRoundTrip() の例
<perform  value="$HMLPSUtil.enableRoundTrip(true)$" />
getCursorCol()
public int getCursorCol()

このメソッドは、表示スペースでのテキスト・カーソルのカラムの位置を戻します。

図 34. getCursorCol() の例
<input value="$HMLSessionUtil.getHost()$"
          row="$HMLPSUtil.getCursorRow()$"
          col="$HMLPSUtil.getCursorCol()$+2"
          movecursor="true" xlatehostkeys="true"
          encrypted="false" />
getCursorPos()
public int getCursorPos()

このメソッドは、表示スペースでのテキスト・カーソルの位置を戻します。

図 35. getCursorPos() の例
<varupdate name="$cursor_pos$" value="$HMLPSUtil.getCursorPos()$" />
         
getCursorRow()
public int getCursorRow()

このメソッドは、表示スペースでのテキスト・カーソルの行の位置を戻します。

図 36. getCursorRow() の例
<input value="$HMLSessionUtil.getHost()$"
          row="$HMLPSUtil.getCursorRow()$"
          col="$HMLPSUtil.getCursorCol()$+2"
          movecursor="true" xlatehostkeys="true"
          encrypted="false" />
getSize()
public int getSize()

このメソッドは、表示スペースのサイズ (表示スペースでの文字の位置の数) を 戻します。例えば、セッション・ウィンドウに 25 の行と 80 のカラムが ある場合は、表示スペースのサイズは 24 * 80 = 1920 です。

図 37. getSize() の例
<varupdate name="$size$" value="HMLPSUtil.getSize()$" />
getSizeCols()
public int getSizeCols()

このメソッドは、表示スペースのカラム数を戻します。表示スペースには、 セッション・ウィンドウと同じカラム数があります。例えば、セッション・ ウィンドウに 25 の行と 80 のカラムがある場合は、表示スペースの カラム数は 80 です。

図 38. getSizeCols() の例
<varupdate name="$size_cols$" value="$HMLPSUtil.getSizeCols()$" />
getSizeRows()
public int getSizeRows()

このメソッドは、表示スペースの行数を戻します。表示スペースには、 セッション・ウィンドウの行数より 1 少ない行があります (これは、 オペレーター情報域を含むセッション・ウィンドウの最後の行が表示スペースに 含まれていないためです)。例えば、セッション・ウィンドウに 25 の行と 80 のカラムがある場合は、表示スペースの行数は 24 です。

図 39. getSizeRows() の例
<varupdate name="$size_rows$" value="$HMLPSUtil.getSizeRows()$" />
getString()
public String getString(int pos, int len)

このメソッドは、表示スペースでの指定位置で始まり、指定された文字数の間 続くテキスト・ストリングを戻します。

図 40. getString() の例
<varupdate name="$text_of_row_18$"
          value="$HMLPSUtil.getString(
                    $HMLPSUtil.getSizeCols()$*17+1,
                    $HMLPSUtil.getSizeCols()$)$" />
searchString()
public int searchString(String str)

このメソッドは、指定されたストリングの表示スペースでの位置を戻します。 このメソッドは、表示スペースにストリングがない場合は 0 を戻します。

図 41. searchString() の例
<varupdate name="$pos_ofIBM$" value="$HMLPSUtil.searchString('IBM')$" />

$HMLSessionUtil$

$HMLSessionUtil$ で呼び出されるこのメソッドは、セッションに関連する 値を戻します。表 17 は、これらのメソッドの 要約を示します。

表 17. $HMLSessionUtil$ のメソッドの要約
METHOD SUMMARY: $HMLSessionUtil$
String
getHost()
セッション構成の Destination Address フィールドで 指定されたテキスト・ストリングを戻します。
String
getLabel()
セッション構成の Session Name フィールドで 指定されたストリングを戻します。
String
getName()
ホストによってセッションに割り当てられたセッション・インスタンス ID を 戻します。

メソッドの詳細

getHost()
public String getHost()

このメソッドは、セッション構成の「接続 (Connection)」セクションの「宛先アドレス (Destination Address)」フィールドに入力した ホスト名またはホスト・アドレスを戻します (myhost.myloc.mycompany.com または 9.27.63.45 など)。

図 42. getHost() の例
<varupdate name="$host$" value="$HMLSessionUtil.getHost()$" />
getLabel()
public String getLabel()

このメソッドは、セッション構成の「接続 (Connection)」セッションの「セッション名 (Session Name)」フィールドに入力したセッション名を戻します (3270 Display または 5250 Display などの名前)。

図 43. getLabel() の例
<varupdate name="$label$" value="$HMLSessionUtil.getLabel()$" />
getName()
public String getName()

このメソッドは、ホストがセッションに割り当てた識別名を戻します (A、B、または C など)。 セッションを開始すると、ホストは、開始している可能性がある同じセッションの 他のインスタンスと区別するために、そのセッションに名前を割り当てます。

図 44. getName() の例
<varupdate name="$name$" value="$HMLSessionUtil.getName()$" />

$HMLSQLUtil$

$HMLSQLUtil$ で呼び出されたメソッドは、最新の SQLQuery アクションの結果に 関する情報を戻します。 表 18 は、これらのメソッドの要約を示します。

表 18. $HMLSQLUtil$ のメソッドの要約
METHOD SUMMARY: $HMLSQLUtil$
int
getColumnSize()
データのカラム数を戻します。
String
getDataByIndex()
指定された行の索引とカラムの索引にある項目を戻します。
String
getDataByName()
指定された行の索引とカラム名 (フィールド名) にある項目を戻します。
int
getRowSize()
データの行数を戻します。

保管データの形式

SQLQuery アクションの結果は、戻されるデータ・ブロックのサイズよりカラムおよび行がそれぞれ 1 つ多い二次元の配列として保管されます。行 0 は、 カラムの名前 (データベースからのフィールド名) を保管するために使用され、 カラム 0 は、0 を基準とした索引を保管するために使用されます (以下の表 19 を参照)。行 0、カラム 0 にある 項目には、空ストリングが含まれています。配列の残りには、実際のデータが 含まれています。値はすべてストリングです。

表 19 は、4 x 6 の配列に保管された 3 x 5 のデータ・ブロックの照会の結果を例として示しています。

表 19. 結果を含む二次元の配列の例
(空ストリング) TOPICID EXMPLID DESCRIPT
0 4 18 カスタム・ボタンでツールバーを作成します。
1 9 54 開始時に表を付加します。
2 11 74 製品を編集します。
3 11 75 製品を入力または編集します。
4 11 76 カスタマーを検索します。

上の表では、行 0、カラム 0 にある項目には、空ストリングが含まれています。 行 0 の残りには、データベースのフィールド名 (TOPICID、EXMPLID、DESCRIPT) が 含まれています。カラム 0 の残りには、行 (0、1、2、3、4) の索引番号が 含まれています。実際のデータは、配列の残りに含まれています。値はすべてストリングです。

メソッドの詳細

getColumnSize()
public int getColumnSize()

このメソッドは、追加されたカラム 0 を含む、配列内のデータの 実際のカラム数を戻します。例えば、表 19 の 配列では、このメソッドは 4 を戻します。

図 45. getColumnSize() の例
<varupdate name="$col_size$" value="$HMLSessionUtil.getColumnSize()$" />
getDataByIndex()
public int getDataByIndex(int row, int column)

このメソッドは、指定された行とカラムの索引にある項目を戻します。 次のリストは、表 19 に示すデータに戻される 値を示します。

図 46. getDataByIndex() の例
<varupdate name="$data$" value="$HMLSessionUtil.getDataByIndex(3,3)$" />
getDataByName()
public int getDataByName(int row, String fieldName)

このメソッドは、指定された行の指定されたフィールド名に項目を戻します。 次のリストは、表 19 に示すデータに戻される 値を示します。

図 47. getDataByName() の例
<varupdate name="$data$" value="$HMLSessionUtil.getDataByName(3,'DESCRIPT')$" />
getRowSize()
public int getRowSize()

このメソッドは、追加された行 0 含む、配列内のデータの 実際の行数を戻します。例えば、表 19 の 配列では、このメソッドは 6 を戻します。

図 48. getRowSize() の例
<varupdate name="$row_size$" value="$HMLSessionUtil.getRowSize()$" />

FormatNumberToString() および FormatStringToNumber()

$FormatNumberToString()$ の代わりに $HMLFormatUtil.numberToString()$ を使用してください。前者は、後者と同じ入力パラメーターと 戻りタイプを持ちます (numberToString()を参照)。

$FormatStringToNumber()$ の代わりに $HMLFormatUtil.stringToNumber()$ を使用してください。前者は、後者と同じ入力パラメーターと 戻りタイプを持ちます (stringToNumber()を参照)。