ソース・ノードの階層内の 1 つのレベルを表す、ツリー・ノードの配列を作成します。
構文
public TreeNode[] getTreeNodes(String parentNodePath, String searchPattern);
パラメーター
戻り値
TreeNode オブジェクト (指定されたオブジェクト階層内の下位ノードとなっているツリー・ノード・オブジェクト) の配列です。
例外
注記
getTreeNodes() メソッドは、IGeneratesBoDefs インターフェース用のソース・ノード生成メソッドです。ビジネス・オブジェクト・ウィザードが getTreeNodes() を起動すると、ウィザードの「ソースの選択」(ステップ 3) ダイアログ・ボックスを初期化するツリー・ノードの配列が取得されます。
このダイアログ・ボックスから、ビジネス・オブジェクト定義生成用の特定のソース・ノードを選択します。データ・ソース内のソース・ノードの階層を表すツリー・ノードは、getTreeNodes() メソッド内で構築しておく必要があります。getTreeNode() メソッドは、このソース・ノードの階層を TreeNode オブジェクトの配列として、呼び出し元のビジネス・オブジェクト・ウィザードに戻します。
getTreeNodes() が戻すツリー・ノード配列によって、ソース・ノード階層の特定レベルにソース・ノードができます。どのレベルにおいても、一部のソース・ノードを拡張可能な (下位ノードを持つ) ソース・ノードにし、ほかのソース・ノードをリーフ (終端) ノードにすることができます。ソース・ノードの左側にプラス (+) 記号が表示されているときは、そのソース・ノードを展開することによって、階層をトラバースすることができます。ユーザーがノードを展開すると、ビジネス・オブジェクト・ウィザードによって getTreeNodes() が再度呼び出され、ユーザーが展開するノードの名前がこのメソッドの parentNodePath 引き数として指定されます。このノード名は、パス内の各ノードの名前で構成されます。ノード名はそれぞれコロン (:) で区切られます。
getTreeNodes() メソッドは、以下の基本タスクを実行して、ソース・ノードを生成します。
ビジネス・オブジェクト・ウィザードが searchPattern 引き数を getTreeNodes() に渡すと、ユーザーによる検索基準の指定が完了します。結果として、getTreeNodes() によって戻されるノードは必然的に parentNodePath ノードの下位ノードのうち searchPattern の検索基準に適合した下位ノードだけに限られることになります。検索パターンをソース・ノードに適用可能にするためには、以下の条件が true でなければなりません。
ODA のメタデータ (AgentMetaData) オブジェクト内にある searchPatternDesc メンバー変数により、サポートされている検索基準の説明がユーザーに対して表示されます。ただし、ユーザー指定の searchPattern については、getTreeNodes() メソッドで解析して、サポートされている検索基準に適合することを確認しておく必要があります。
ODA のメタデータ (AgentMetaData) オブジェクト内の searchableNodes メンバー変数は trueでなければなりません。searchableNodes が false の場合、検索基準のユーザー入力を開始するための「項目を検索」メニュー項目は利用できません。この場合は、検索基準のユーザー入力はできません。
getTreeNodes() の実装方法について詳しくは、ソース・ノードの生成を参照してください。
参照
関連する参照情報については、TreeNode クラスを参照してください。