API 使用レポート

API 使用レポートは、1 つのバンドル・セットから別のバンドル・セットへの参照から成るセットを記述します。 API 使用 Ant タスクを使ってレポートを生成できます。 「外部ツール」ダイアログでレポートを構成および生成するためのユーザー・インターフェースがあります。 新しい使用スキャン構成は、「API 使用レポート」構成タイプをダブルクリックするだけで作成できます。

「API 使用レポート」タブ

「API 使用レポート」タブにより、分析を構成できます。

以下の例は、3.4 インストレーションでの Eclipse バンドルへの参照をすべて取り出す構成を示しています。

「API 使用レポート」タブ


オプション

説明

デフォルト

分析 分析対象を選択できます。対象は、API ベースライン、ターゲット定義またはバンドルのディレクトリーのどれでもかまいません。 既存レポートの HTML を生成するだけの選択項目もあります。 1 つのオプションのみ選択し、それぞれのオプション毎に構成を実行できます。 すなわち、「API ベースライン」の分析を選択している場合は、「API ベースライン」設定ページを使用して既存ベースラインを編集できます。 API ベースライン
「分析」>「API ベースライン」 コンボ・ボックスから、分析する API ベースラインを選択することができます。 デフォルト・ベースラインまたは空
「分析」>「ベースライン...」 分析のためのベースラインを構成する「API ベースライン」 設定ページにアクセスします。  
「分析」>「ターゲット定義」 コンボ・ボックスから、分析するターゲット定義を選択することができます。 アクティブなターゲット定義または空
「分析」>「ターゲット」 分析のためのターゲット定義を構成する「ターゲット・プラットフォーム」設定ページにアクセスします。  
「分析」>「ディレクトリー」 バンドルを含むディレクトリーへの絶対パスを入力できます。 空
「分析」>「参照...」 分析するバンドルのフォルダーを参照できます。  
「分析」>「既存の使用スキャンの HTML レポートを生成」 既存スキャンのレポートを作成しますが、分析の再実行は必要ありません。  
「検索」>「参照先」 参照先を表示するバンドルの名前 (またはマッチングする RegEx) を指定できます。 以下の例を考慮してみましょう: org¥.eclipse.*。 この例では、名前が org.eclipse. で始まるすべてのバンドルへのすべての参照を表示することを指定していることになります。 空
「検索」>「API 参照」 API 参照をスキャンできます。 unchecked
「検索」>「内部参照」 内部参照をスキャンできます。 checked
「検索」>「不正な API 使用」 正しくない API の使用、すなわち、制限された API メンバーの使用をスキャンできます。 unchecked
「次を検索」>「マッチングするバンドル」 参照をスキャンするバンドルの名前 (またはマッチングする RegEx)、すなわち、検索の範囲を指定できます。 以下の例を考慮してみましょう: .*。 この例では、名前が任意の文字シーケンスに一致するすべてのバンドルを検索することを指定していることになります。 フィールドをブランクのままにしても、同じ効果があります。 空
「レポート」>「レポート・タイプ (Report Type)」 2 つの HTML レポート・フォーマットから選択できます。「参照先バンドル・レポート (プロデューサー)」が選択されている場合、レポートは、検索対象のバンドルで参照されているタイプを含むすべてのバンドルをリストします。「参照元バンドル・レポート (コンシューマー)」が選択されている場合、レポートは、参照を含む検索範囲内のすべてのバンドルを表示するように編成されます。

レポート・タイプを切り替える際には、「参照先」および「バンドルの一致」正規表現が正しい値になっていることを確認してください。一方の設定で .* などのワイルドカード式を使用している場合、もう一方のレポート・タイプに切り替える際には、多くの場合、ワイルドカードをその他の設定に変更して最も有用なレポートを入手する必要があります。

参照先バンドル・レポート (プロデューサー)
「レポート」>「レポート出力場所」 生成されるレポートが置かれる絶対パスを指定できます。 空
「レポート」>「参照...」 すべてのレポートの出力場所を選択できます。  
「レポート」>「新規結果のレポート前にレポート・ディレクトリーをクリーニング」 すべての結果のスキャン・レポートの前に、既存 XML レポートのロケーションを消去できます。このオプションを指定すると、指定されたレポート・ディレクトリーが存在している場合には完全に削除されることに注意してください。すべての子ディレクトリーも同じように再帰的に削除されます。 unchecked
「レポート」>「HTML レポートの作成」 すべての XML 出力をフォーマット済み HTML に変換し、<report location>¥html に入れます。 unchecked
「レポート」>「HTML レポート・ロケーションのクリーニング」 新規レポートを作成する前に、既存 HTML のロケーションを消去できます。このオプションを指定すると、指定された HTML ディレクトリーが存在している場合には完全に削除されることに注意してください。すべての子ディレクトリーも同じように再帰的に削除されます。 このオプションは、「HTML レポートの作成」オプションが上記のように選択されている場合にしか使用可能になりません。 unchecked
「レポート」>「検索が完了したらレポートを開く」 分析が完了したら HTML レポートを開きます。このオプションは、「HTML レポートの作成」オプションが上記のように選択されている場合にしか使用可能になりません。 unchecked
「レポート」>「説明」 人が読めるレポートの説明を入力できます。 空

「パターン」タブ

「パターン」タブにより、使用分析を制御するための様々な「正規表現」パターンを作成できます。 現在、3 種類のパターンがサポートされています。

  1. 「アーカイブのパターン」- 分析中に無視する必要のある、ネストされたアーカイブを指定できます。
  2. 「パッケージのパターン」- API または内部にする必要があるパッケージを、バンドル・マニフェストを更新することなく指定できます。
  3. 「レポート変換パターン」- パッケージ名正規表現を作成して、レポートされる参照をフィルターに掛けることができます。 すべてのレポートされた参照は、完全修飾されたパッケージ名を使用してフィルター処理されます。

「パターン」タブ


オプション

説明

デフォルト

追加... 新しいパターンを追加します。 このボタンは、「パターン」ウィザードを開始します。  
編集 現在選択されているパターンを編集することができます。 一度に編集できるパターンは 1 つのみです。  
削除 選択されたパターンを削除します。 一度に複数のパターンを削除できます。  

関連タスク

API ベースラインとの比較
ベースラインのセットアップ

関連リファレンス

API ベースラインの設定
「API 使用パターン (API Use Patterns)」ウィザード