追加の JasperReport ハンドラー関数

ハンドラー・パーツに JasperReport ステレオタイプを追加すると、自動的に複数の暗黙の EGL 関数が使用可能になります。 さらに、JasperReports 設計ファイルにより、内部の Java™ メソッド getDataSource() を呼び出すことができます。

JasperReports は、レポート・エンジンが実行時に評価する以下の 3 種類のエンティティーを区別します。

JasperReport ハンドラー内から、以下のセクションに示す暗黙の関数のいずれかを呼び出すことができます。 XML 設計ファイル・ソースから、getDataSource() を呼び出します (これは内部 EGL Java メソッドです)。

レポート・パラメーターの取得用の関数

関数 説明
getReportParameter (parameter STRING in) 埋め込み中のレポートから、指定のパラメーターの値を戻します。 戻り値は、ANY 型です。

レポート変数の設定と取得用の関数

以下の関数を実行時に使用すると、レポートが使用する変数にアクセスできます。

関数 説明
getReportVariableValue(variable STRING in) 埋め込み中のレポートから、指定の変数の値を戻します。戻り値は、ANY 型です。
setReportVariableValue (variable STRING in, value Any in) 値を指定の変数に割り当てます。

フィールド値の取得用の関数

以下の関数を使用すると、レポート内の現在のフィールドにアクセスできます。

関数 説明
getFieldValue(fieldName STRING in) 現在処理中の行について、指定のフィールド値を戻します。戻り値は、ANY 型です。

サブレポート用のデータの保存または検索用の関数

サブレポートは、別のレポート内から呼び出せるレポートです。 レポート・データをサブレポートに渡す場合、JasperReport ハンドラーは最初に addReportData() を使用して情報を保存します。 JasperReports エンジンは getDataSource() を使用してこのデータを検索できます。このトピックの『レポート設計ファイルに使用可能な Java メソッド』を参照してください。 JasperReport ハンドラーで以前に保存したデータを検索するには、同等の getReportData() 関数を使用します。

関数 用途
addReportData (rd ReportData in, dataID String in) (ReportData 変数に保存された) データを名前 dataID に関連付けます。
getReportData (dataID String in) addReportData() を使用して、以前に dataID の下に保存したデータを検索します。 getReportData() は、ReportData 型の値を戻します。

レポート設計ファイルに使用可能な Java メソッド

サブレポートに渡すデータにアクセスするには、XML レポート設計ファイルから getDataSource() 関数を呼び出します。

関数 用途
getDataSource(dataID STRING in)

レポート設計ファイルで、以前に JasperReport ハンドラーで addReportData() を呼び出したときに dataID として保存したデータを検索します。

getDataSource() は、データを内部フォーマットで戻します。 サブレポートがそのデータを使用できるように、戻り値を JRDataSource としてキャストする必要があります。

このトピックで説明された関数の使用法の例については、「EGL プログラマー・ガイド」を参照してください。


フィードバック