トポロジー・レポート式の関数

BIRT データ・セットの式を作成する際に、これらの関数を使用することができます。関数および事前定義済みの XPath 式のリストを見るには、「式」フィールドで Ctrl + スペースを押します。

行と列の式

BIRT データ・セットには、どのデータを取得するかを指定する式が複数入っています。各データ・セットには、1 つの行照会があります。これは、データ・セットの行に対してデータを指定する式です。例えば、トポロジーの各ユニットを (列にはユニットに関する情報を表示して) リストした表を表示しようとする場合、次の式を使用して行照会を作成できます。

DeployCoreRoot/topology/_schema-element_unit

行照会に式を指定した後は、列定義に 1 つ以上の式を指定します。これらの式により、行照会で識別されるトポロジー要素に関する情報が提供されます。例えば、作成した行照会がユニットを戻すものである場合は、列定義を指定して、そのユニットの属性を取得する (例えば、説明を取得するには @description、インストール時の初期状態を取得するには @initInstallState) ことができます。

関数を使用すると、取得しようとする情報に関する詳細を、行照会または列定義で得ることができます。一部の関数は行照会に適しており、その他の関数は列定義に適しています。

行照会の関数

関数を使用すると、行照会で複雑なデータを指定できます。例えば、行照会で getHosted 関数を使用すると、指定されたユニットがホストするユニットのみを含むデータ・セットを作成することができます。この関数を使用するには、カスタム・レポート・テンプレートの作成で説明する方法でトポロジー・モデル・データ・ソースをインポートして、 myUnit などの照会パラメーターを使用してこのデータ・ソースから新しいデータ・セットを作成し、このパラメーターと getHosted 関数をそのデータ・セットの照会で使用します。また、行マッピングの「型」フィールドを、照会に対して互換性のある戻り値の型に設定する必要もあります。ユニットを戻す照会の場合、「core:Unit」と指定できます。

getHosted(resolveURI($myUnit))

多くの関数と同様に、getHosted 関数も XPath ロケーションをパラメーターとして受け入れます。この場合は、ホスト・ユニットのロケーションになります。よく使用される XPath 式をトポロジー・レポートに事前定義された XPath 式に掲載します。

ただし、多くの関数は、 XPath ロケーションではなくトポロジー要素の URI を戻します。この URI には、ご使用のワークスペースにあるトポロジー・ファイルのロケーションと、トポロジー内のユニットの ID が入っています。例:

platform:/resource/MyProject/topologies/MyNamespace/MyTopology.topology#/Unit_1

URI を関数に渡すためには、XPath ロケーションに変換する必要があります。 resolveURI 関数を使用して、URI を XPath ロケーションに変換することができます。例:

resolveURI('platform:/resource/MyProject/topologies/MyNamespace/MyTopology.topology#/Unit_1')

多くの場合、XPath ロケーションや URI をストリング・リテラルとして指定する必要はありません。レポート・テンプレートに入っているほとんどのデータ・ソースには、ユニットの XPath ロケーションまたはその他のトポロジー要素を指定する URI フィールドが含まれています。ユニットまたはその他のトポロジー要素を見つけるために、この URI パラメーターを関数や別のデータ・セットに渡すことができます。

行照会で使用するための関数は、レポートの行の関数に掲載されています。

列定義の関数

関数では、行照会で戻される各トポロジー要素についてのより複雑な情報を戻すことができます。一連のデータを戻す行照会関数とは異なり、列定義関数では、通常は文字列、整数、ブールなどのプリミティブ値を持つ 1 つのデータが戻されます。

例えば、getCaption 関数は文字列を戻します。 DeployCoreRoot/topology/_schema-element_unit などのデータ・セット照会を使用して、一連のユニットを戻すデータ・セットを作成した場合、getCaption 関数を使用して、各ユニットのキャプションを表示する列をデータ・セットに作成できます。

行照会関数と同じように、列定義関数もパラメーターとして XPath ロケーションを使用します。ただし、XPath ロケーションは、行照会で戻されたトポロジー要素に相対的なものです。例えば、行照会によってユニットが戻された場合、列定義で使用するためのユニットの XPath ロケーションは、ピリオドです。前述の例のように、行照会によって一連のユニットが戻された場合は、式 getCaption(., 'true', 'true') を使用して、これらのユニットのそれぞれにキャプションを含む列を作成することができます。

トポロジーで使用する UML 関数と EMF 関数

以下の関数は、 Eclipse モデリング・フレームワーク (EMF) データ・セットと UML データ・セットで使用するように用意されたものですが、トポロジー・データ・セットでも使用できます。これらの関数は、行照会と列定義で使用できます。

resolveURI(inputURI)

指定されたトポロジー要素の XPath ロケーションを戻します。

inputURI: トポロジー要素の URI。

戻り値の型: 文字列

getURI(inputElement)

指定されたトポロジー要素の URI を戻します。

inputElement: トポロジー要素の XPath ロケーション。

戻り値の型: 文字列

getXMIType(inputElement)

指定されたトポロジー要素の型を戻します。

inputElement: トポロジー要素の XPath ロケーション。

戻り値の型: 文字列

EMF および UML データ・セットの追加の XPath 関数にリストされている他の関数も使用することができます。

フィードバック