API Java à utiliser avec les lignes de base et les libellés id175UB30E05Z
Affichez
Les API Java suivantes vous permettent de créer une ligne de base et d’ajouter des libellés aux fichiers d’une ligne de base. Ces API sont disponibles sous la forme d’un lot. Vous devez inclure ce lot dans votre code pour utiliser ces API.
Détails du lot :
-
ID de groupe : com.adobe.fmdita
-
ID d’artefact : api
-
Version : 3.5
-
Package : com.adobe.fmdita.api.baselines
-
Détails de la classe :
code language-java public class BaselineUtils extends ObjectLa classe BaselineUtils contient des méthodes pour créer des lignes de base et appliquer des étiquettes aux fichiers d’une ligne de base.
Création d’une ligne de base
La méthode de création de ligne de base comporte deux versions : une pour la solution XML Documentation version 3.5 et une autre pour les versions antérieures à la version 3.5 (qui inclut les versions 3.4, 3.3 et 3.2). L’API version 3.5 permet la création d’une ligne de base à l’aide d’un libellé, de références directes et de références indirectes dans un fichier map.
L’autre version de l’API utilise la date et l’heure pour créer une ligne de base. Cette API est conservée à des fins de rétrocompatibilité avec les systèmes utilisant la solution XML Documentation 3.4, 3.3 ou 3.2.
Syntaxe (pour la version 3.5) :
public static String createBaseline(Session session,
String sourcePath,
String baselineTitle,
String label,
LinkedHashMap directContext,
LinkedHashMap indirectContext)
throws GuidesApiException
Paramètres :
sessionsourcePathbaselineTitlelabeldirectContextSi, après une itération sur toutes les clés de la carte, aucune version n’est trouvée, le processus de création de ligne de base échoue.
Si HashMap est vide (envoyez une carte vide et non nulle pour la valeur par défaut), par défaut, elle est renseignée comme suit :
directContext.put("label", label);directContext.put("latest", true);Si vous souhaitez que la création de la ligne de base ne sélectionne que la version d’une étiquette donnée et échoue en l’absence d’une telle version, placez la clé
label et le libellé sur lequel vous souhaitez créer la ligne de base.indirectContextSi, après une itération sur toutes les clés de la carte, aucune version n’est trouvée, le processus de création de ligne de base échoue.
Si HashMap est vide (envoyez un mappage vide et non nul par défaut), il est renseigné par défaut comme suit :
indirectContext.put("label", label);indirectContext.put "pickAutomatically", null);Si vous souhaitez qu’il s’agisse de la dernière version au lieu de récupérer automatiquement une version, puis remplacez :
indirectContext.put("pickAutomatically", null);avec :
indirectContext.put("latest", true)Renvoie :
Nom de la ligne de base, qui est le nom de noeud de la ligne de base dans le référentiel JCR. Le titre de la ligne de base nouvellement créée s’affiche pour l’utilisateur sur la page Ligne de base pour le mappage DITA.
Exception :
Renvoie ItemExistExceptiom s’il existe déjà une ligne de base portant le même titre.
Syntaxe (pour les versions 3.4, 3.3 et 3.2)
public static String createBaseline
(Session session,
String sourcePath,
String baselineTitle,
Date versionDate) throws GuidesApiException
Paramètres :
sessionsourcePathbaselineTitleversionDated-MM-yyyy H:mm.Renvoie :
Nom de la ligne de base, qui est le nom de noeud de la ligne de base dans le référentiel JCR. Le titre de la ligne de base nouvellement créée s’affiche pour l’utilisateur sur la page Ligne de base pour le mappage DITA.
Exception :
Throws RepositoryException.
Application de libellés
La méthode applyLabel applique une ou plusieurs étiquettes aux fichiers d’une ligne de base.
Syntaxe:
public static void applyLabel(Session session,
String sourcePath,
String baselineName,
String label)
throws RepositoryException, WorkflowException, Exception
Paramètres :
sessionsourcePathbaselineNameRemarque : Le libellé est appliqué à la version des fichiers directement référencés à partir du fichier map dans la ligne de base.
labelSi vous souhaitez définir plusieurs libellés, séparez-les par une virgule, par exemple, Libellé2.
Exception :
Lance RepositoryException.
Supprimer des étiquettes
La méthode deleteLabel supprime une ou plusieurs étiquettes des fichiers d’une ligne de base.
Syntaxe:
public static Map
<String, String> deleteLabel(Session session,
String sourcePath,
String baselineName,
String label) throws GuidesApiException
Paramètres :
sessionsourcePathbaselineNameRemarque : Le libellé est supprimé de la version des fichiers qui sont directement référencés à partir du fichier map dans la ligne de base.
labelSi vous souhaitez supprimer plusieurs étiquettes, séparez-les par une virgule ; par exemple, Libellé1, Libellé2.
Renvoie :
La carte avec la paire key:value de path:deletedlabels pour tous les fichiers de la ligne de base.
Exception :
Lance RepositoryException`, `VersionException`, `Exception.