ベースラインとラベルを操作するための Java ベースの API
- トピック：
- Java ベースの API ベースライン
作成対象：
- 経験者
- 開発者
メモJava ベースの API の使用に関する最新および詳細なドキュメントについては、
次の Java ベースの API を使用すると、ベースラインを作成し、ベースライン内のファイルにラベルを追加できます。 これらの API は、バンドルの形式で使用できます。 これらの API を使用するには、コードにこのバンドルを含める必要があります。
バンドルの詳細
-
グループ ID:com.adobe.fmdita
-
アーティファクト ID: api
-
バージョン：3.5
-
パッケージ：com.adobe.fmdita.api.baselines
-
クラス詳細：
public class BaselineUtils extends ObjectBaselineUtils クラスには、ベースラインを作成し、ベースライン内のファイルにラベルを適用するためのメソッドが含まれています。
ベースラインの作成
ベースラインの作成メソッドには、XML Documentation ソリューションバージョン 3.5 用と、3.5 リリースより前のバージョン \（バージョン 3.4、3.3、および 3.2\を含む）用の 2 つのバージョンがあります。 バージョン 3.5 API では、マップ ファイル内のラベル、直接参照、間接参照を使用してベースラインを作成できます。
他のバージョンの API では日時を使用してベースラインを作成します。 この API は、XML Documentation ソリューション 3.4、3.3 または 3.2 を使用しているシステムとの下位互換性を保つために保持されています。
構文\（バージョン 3.5\用）:
public static String createBaseline(Session session,
String sourcePath,
String baselineTitle,
String label,
LinkedHashMap directContext,
LinkedHashMap indirectContext)
throws GuidesApiException
パラメーター:
sessionsourcePathbaselineTitlelabeldirectContextマップのすべてのキーを反復処理した後にバージョンが見つからない場合、ベースラインの作成プロセスは失敗します。
HashMap が空の\（send empty and not null map for default\）の場合、デフォルトでは
directContext.put("label", label);と入力されます
directContext.put("latest", true);ベースラインの作成で特定のラベルのバージョンのみを選択し、そのバージョンが存在しない場合に失敗する場合は、ベースラインを作成するラベルと
label キーを入力します。indirectContextマップのすべてのキーを反復処理した後にバージョンが見つからない場合、ベースラインの作成プロセスは失敗します。
HashMap が空の\（send empty and not null map for default\）の場合、デフォルトでは、次のように入力されます。
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);バージョンを自動的に取得する代わりに最新バージョンにする場合は、
indirectContext.put("pickAutomatically", null);を置換します。 with:
indirectContext.put("latest", true)戻り値
ベースラインの名前（JCR リポジトリのベースラインのノード名）。 新しく作成されたベースラインのタイトルは、DITA マップの「ベースライン」ページでユーザーに表示されます。
例外:
同じタイトルのベースラインが既に存在する場合、ItemExistExceptiom をスローします。
構文\（バージョン 3.4、3.3、3.2 の場合）
public static String createBaseline
(Session session,
String sourcePath,
String baselineTitle,
Date versionDate) throws GuidesApiException
パラメーター:
sessionsourcePathbaselineTitleversionDated-MM-yyyy H:mm ます。戻り値
ベースラインの名前（JCR リポジトリのベースラインのノード名）。 新しく作成されたベースラインのタイトルは、DITA マップの「ベースライン」ページでユーザーに表示されます。
例外:RepositoryException. をスロー
ラベルの適用
applyLabel メソッドは、ベースラインのファイルに 1 つまたは複数のラベルを適用します。
構文：
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
パラメーター:
sessionsourcePathbaselineNameで DITA マップのベースラインノードを確認します。 メモ： ラベルは、ベースラインのマップファイルから直接参照されるファイルのバージョンに適用されます。
label複数のラベルを設定する場合は、ラベルをコンマで区切ります（例：Label1, Label2）。
例外:RepositoryException をスローします。
ラベルを削除
deleteLabel メソッドは、ベースラインのファイルから 1 つまたは複数のラベルを削除します。
構文：
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
パラメーター:
sessionsourcePathbaselineNameメモ： ラベルは、ベースラインのマップファイルから直接参照されるファイルのバージョンから削除されます。
label複数のラベルを削除する場合は、コンマでラベルを区切ります（Label1、Label2 など）。
戻り値
ベースライン内のすべてのファイルの path:deletedlabels の key:value ペアを持つマップ。
例外:RepositoryException`, `VersionException`, `Exception をスローします。