使用DITA map的Java型API id175UB30E05Z

NOTE

您可以使用Experience Manager Guides中提供的Java式API來建立自訂外掛程式，並擴充現成可用的工作流程。 本文將會在2024年11月封存。
檢視 ，以取得有關使用Java型API的最新和詳細檔案。

下列Java型API可讓您在AEM Guides中使用DITA map。 這些API以套件組合的形式提供。 您必須在程式碼中包含此套件組合，才能使用這些API。

套件組合詳細資料：

下載具有相依物件的DITA map

zipMapWithDependents方法會建立包含DITA map及其所有相依專案（例如參照的主題、子地圖、影像和DTD）的.zip檔案。 DITA map的.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 map \（非同步\）

或者，您可以以非同步模式下載具有相依物件的DITA map。 此方法對於較大的DITA map比較實用。

zipMapWithDependents方法會建立包含DITA map及其所有相依專案（例如參照的主題、子地圖、影像和DTD）的.zip檔案。 DITA map的.zip檔案是根據指定的基準線建立的。

它也可讓您維持相同的結構\（父資料夾和子資料夾\），或在單一資料夾內為所有相依檔案建立平面檔案結構。

語法：

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

引數：

傳回：
Zip檔案的Node已包裝在CompletableFuture類別中。 使用者可以繼續以非同步方式處理它，並且可以在需要節點時使用未來的.get()方法來封鎖執行緒。 傳回的值也可能以錯誤結束，而且可以使用.exceptionally()方法處理。

取得基準線清單

getBaselineList方法會擷取特定DITA map存在的所有基準清單。

語法：

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

引數：

傳回：
HashMap物件的清單。 每個HashMap物件代表一個基準線，並包含基準線的名稱和標題。

例外狀況：
擲回javax.jcr.RepositoryException。

取得條件預設集清單

getConditionalPresetList方法會擷取特定DITA map存在的所有條件預設集清單。

語法：

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

引數：

傳回：
HashMap物件的清單。 每個HashMap物件代表一個條件式預設集，並包含條件式預設集的名稱和標題。

例外狀況：
擲回javax.jcr.RepositoryException。

取得條件預設集的DITAVAL檔案資訊

getDitavalFromConditionalPreset方法會擷取與指定DITA map的條件預設集相對應的DITAVAL檔案路徑。

語法：

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

引數：

傳回：
與DITA map檔案中定義的條件預設集相對應的DITAVAL檔案路徑。

取得節點的所有相依性

getAllDependencies方法會傳回指定節點的所有相依性。

語法：

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

引數：

傳回：
包含根節點所有相依性的節點清單。