API basate su Java per lavorare con le linee di base e le etichette id175UB30E05Z
Le seguenti API basate su Java consentono di creare una linea di base e aggiungere etichette ai file in una linea di base. Queste API sono disponibili sotto forma di bundle. Per utilizzare queste API, devi includere questo bundle nel codice.
Dettagli bundle:
-
ID gruppo: com.adobe.fmdita
-
ID artefatto: api
-
Versione: 3.5
-
Pacchetto: com.adobe.fmdita.api.baselines
-
Dettagli classe:
code language-java public class BaselineUtils extends ObjectLa classe BaselineUtils contiene i metodi per la creazione di baseline e l'applicazione di etichette ai file in una baseline.
Creare una baseline
Il metodo di base per la creazione dispone di due versioni: una per la soluzione XML Documentation versione 3.5 e l’altra per le versioni precedenti alla versione 3.5 \ (che include le versioni 3.4, 3.3 e 3.2). La versione 3.5 dell’API consente la creazione di una linea di base utilizzando un’etichetta, riferimenti diretti e riferimenti indiretti in un file di mappa.
L’altra versione dell’API utilizza la data e l’ora per creare una linea di base. Questa API viene mantenuta per compatibilità con le versioni precedenti dei sistemi che utilizzano la soluzione XML Documentation 3.4, 3.3 o 3.2.
Sintassi (per la versione 3.5):
public static String createBaseline(Session session,
String sourcePath,
String baselineTitle,
String label,
LinkedHashMap directContext,
LinkedHashMap indirectContext)
throws GuidesApiException
Parametri:
sessionsourcePathbaselineTitlelabeldirectContextSe dopo l'iterazione su tutte le chiavi della mappa non viene trovata alcuna versione, il processo di creazione della linea di base non riesce.
Se l'HashMap è vuoto (invia una mappa vuota e non null per default), per impostazione predefinita viene popolato come:
directContext.put("label", label);directContext.put("latest", true);Se si desidera che la creazione della baseline selezioni solo la versione di una determinata etichetta e non riesca in assenza di tale versione, inserire la chiave
label e l'etichetta su cui si desidera creare la baseline.indirectContextSe dopo l'iterazione su tutte le chiavi della mappa non viene trovata alcuna versione, il processo di creazione della linea di base non riesce.
Se l'HashMap è vuoto (invia una mappa vuota e non nulla per default), per impostazione predefinita viene popolato come:
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);Se si desidera che sia la versione più recente invece di prelevare automaticamente una versione, sostituire:
indirectContext.put("pickAutomatically", null);con:
indirectContext.put("latest", true)Restituisce:
Il nome della linea di base, che è il nome del nodo della linea di base nell’archivio JCR. Il titolo della baseline appena creata verrà visualizzato all'utente nella pagina Baseline della mappa DITA.
Eccezione:
Genera ItemExistExceptiom se esiste già una baseline con lo stesso titolo.
Sintassi (per le versioni 3.4, 3.3 e 3.2)
public static String createBaseline
(Session session,
String sourcePath,
String baselineTitle,
Date versionDate) throws GuidesApiException
Parametri:
sessionsourcePathbaselineTitleversionDated-MM-yyyy H:mm.Restituisce:
Il nome della linea di base, che è il nome del nodo della linea di base nell’archivio JCR. Il titolo della baseline appena creata verrà visualizzato all'utente nella pagina Baseline della mappa DITA.
Eccezione:
Genera RepositoryException.
Applica etichette
Il metodo applyLabel applica una o più etichette ai file di una baseline.
Sintassi:
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
Parametri:
sessionsourcePathbaselineNameNota: l'etichetta viene applicata alla versione dei file a cui viene fatto riferimento direttamente dal file di mapping nella baseline.
labelSe si desidera impostare più etichette, separarle con una virgola, ad esempio Label1, Label2.
Eccezione:
Genera RepositoryException.
Elimina etichette
Il metodo deleteLabel elimina una o più etichette dai file di una baseline.
Sintassi:
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
Parametri:
sessionsourcePathbaselineNameNota: l'etichetta viene eliminata dalla versione dei file a cui si fa riferimento direttamente dal file di mapping nella baseline.
labelPer eliminare più etichette, separare le etichette con una virgola, ad esempio Label1, Label2.
Restituisce:
Mappa con coppia chiave:valore di path:deletedlabels per tutti i file nella linea di base.
Eccezione:
Genera RepositoryException`, `VersionException`, `Exception.