使用基線和標籤的Java式API id175UB30E05Z
檢視
下列Java式API可讓您建立基準線，並將標籤新增至基準線中的檔案。 這些API以套件組合的形式提供。 您必須在程式碼中包含此套件組合，才能使用這些API。
套件組合詳細資料：
-
群組識別碼： com.adobe.fmdita
-
成品ID： api
-
版本： 3.5
-
封裝： com.adobe.fmdita.api.baselines
-
類別詳細資料：
code language-java public class BaselineUtils extends ObjectBaselineUtils 類別包含建立基準線以及將標籤套用至基準線中的檔案的方法。
建立基準線
建立基準線方法有兩個版本 — 一個用於XML Documentation解決方案3.5版，另一個用於3.5版之前的版本\（包括3.4、3.3和3.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是空的\（傳送空白且預設值不是null的對應\），則預設會填入為：
directContext.put("label", label);directContext.put("latest", true);如果您希望基準線建立僅挑選指定標籤的版本，而且如果不存在此類版本，則會失敗，請放入
label索引鍵和您要建立基準線的標籤。indirectContext如果對映的所有索引鍵執行反複專案後，找不到任何版本，則基準線建立程式會失敗。
如果HashMap是空的\（傳送空白且預設值不是null對應\），則預設會填入為：
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);如果您希望它是最新版本以取代自動擷取版本，則請取代：
indirectContext.put("pickAutomatically", null);具有：
indirectContext.put("latest", true)傳回：
基準線的名稱，是JCR儲存庫中基準線的節點名稱。 新建立之基準線的標題將顯示在DITA map的「基準線」頁面上。
例外狀況：
如果已存在具有相同標題的基準線，則擲回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 map的「基準線」頁面上。
例外狀況：
擲回RepositoryException.
套用標籤
applyLabel方法會將一或多個標籤套用至基準線中的檔案。
語法：
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
引數：
sessionsourcePathbaselineName注意： 標籤已套用至從基線中的對應檔案直接參照的檔案版本。
label若您想要設定多個標籤，請以逗號分隔標籤；例如Label1， Label2。
例外狀況：
擲回RepositoryException。
刪除標籤
deleteLabel方法會從基準線中的檔案刪除一或多個標籤。
語法：
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
引數：
sessionsourcePathbaselineName注意： 標籤會從從基線中的對應檔案直接參照的檔案版本中刪除。
label如果您想要刪除多個標籤，請以逗號分隔標籤；例如Label1、Label2。
傳回：
基準線中所有檔案的對映具有 key：value 對path:deletedlabels。
例外狀況：
擲回RepositoryException`, `VersionException`, `Exception。