DITA マップを操作する Java ベースの API id175UB30E05Z

Last update: Fri Jan 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
Java-Based API Dita Map

作成対象：

Experienced
Developer

次の Java ベースの API を使用して、AEMガイドで DITA マップを操作できます。これらの API は、バンドルの形式で使用できます。これらの API を使用するには、コードにこのバンドルを含める必要があります。

バンドルの詳細：

グループ ID : com.adobe.fmdita
アーティファクト ID: api
バージョン： 3.2
パッケージ： com.adobe.fmdita.api.maps

クラスの詳細：

code language-java
`public class MapUtilities extends Object`

MapUtilities クラスには、DITA マップファイルからメタデータ情報を取得するメソッドが含まれます。

依存を含む DITA マップをダウンロード

The zipMapWithDependents メソッドは、DITA マップと、参照トピック、サブマップ、画像、DTD などのすべての依存を含む.zip ファイルを作成します。 DITA マップ用の.zip ファイルは、指定されたベースラインに基づいて作成されます。

また、同じ構造（親フォルダーと子フォルダー）を維持するか、すべての依存ファイルに対して 1 つのフォルダー内にフラットファイル構造を作成することもできます。

IMPORTANT

依存ファイルが見つからない場合、API は例外をスローし、.zip ファイルの作成に失敗します。

構文：

public static void zipMapWithDependents(Session session,
                     String sourcePath,
                     String baseline,
                     OutputStream outputStream,
                     boolean flatFS)
                     throws RepositoryException, IOException

戻り値:ZIP のコンテンツは、 outputStream.

例外：スロー javax.jcr.RepositoryException, java.io.IOException.

依存を持つ DITA マップをダウンロード\（非同期\）

または、非同期モードで、依存を含む DITA マップをダウンロードできます。この方法は、より大きな DITA マップでより便利です。

NOTE

このノードは、output.history.purgetime 設定（定義されている場合）またはデフォルトで 5 日後に自動削除されます。

構文：

public static CompletableFuture<Node> zipMapWithDependencies(Session session,
                     String sourcePath,
                     String baseline,
                     boolean flatFS)

戻り値:zip ファイルのノードは、 CompletableFutureクラス。ユーザーは、引き続き非同期で処理でき、を使用できます。 .get()ノードが必要な場合にスレッドをブロックする未来のメソッド。返される値はエラーで終わる場合もあり、で処理できます。 .exceptionally() メソッド。

ベースラインのリストを取得する

The getBaselineList メソッドは、指定された DITA マップに存在するすべてのベースラインのリストを取得します。

構文：

public static List<HashMap<String,String>> getBaselineList(
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

パラメーター: |名前|型|説明| |—|—|—| |session|javax.jcr.Session|有効な JCR セッション。| |sourcePath|String|ベースライン情報を取得する DITA マップファイルのパス(AEMリポジトリ内)。|

戻り値: HashMap オブジェクト。各 HashMap オブジェクトは、ベースラインを表し、ベースラインの名前とタイトルを含みます。

例外：スロー javax.jcr.RepositoryException.

条件付きプリセットのリストの取得

The getConditionalPresetList メソッドは、特定の DITA マップに存在するすべての条件付きプリセットのリストを取得します。

構文：

public static List<HashMap<String,String>> getConditionalPresetList (
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

パラメーター: |名前|型|説明| |—|—|—| |session|javax.jcr.Session|有効な JCR セッション。| |sourcePath|String|条件付きプリセット情報を取得する DITA マップファイルのパス(AEMリポジトリ内)。|

戻り値: HashMap オブジェクト。各 HashMap オブジェクトは、条件付きプリセットを表し、条件付きプリセットの名前とタイトルを含みます。

例外：スロー javax.jcr.RepositoryException.

条件付きプリセットの DITAVAL ファイル情報を取得する

The getDitavalFromConditionalPreset メソッドは、指定された DITA マップの条件付きプリセットに対応する DITAVAL ファイルのパスを取得します。

構文：

public static String getDitavalFromConditionalPreset
    (Session session,
    String sourcePath,
    String cpName) throws RepositoryException

パラメーター: |名前|型|説明| |—|—|—| |session|javax.jcr.Session|有効な JCR セッション。| |sourcePath|String|DITAVAL ファイルを取得する DITA マップファイルのパス(AEMリポジトリ内)。| |cpName|文字列|DITAVAL ファイルを取得する DITA マップ内の条件付きプリセットの名前。|

戻り値:DITA マップファイルで定義された条件付きプリセットに対応する DITAVAL ファイルのパス。

ノードのすべての依存関係を取得する

The getAllDependencies メソッドは、指定されたノードのすべての依存関係を返します。

構文：

public static List
<Node> getAllDependencies
(Node rootNode) throws GuidesApiException

パラメーター: |名前|型|説明| |—|—|—| |rootNode|javax.jcr.Node|すべての依存関係を取得するルートノード。|

戻り値：ルートノードのすべての依存関係を含むノードリスト。

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178