Rapports d'utilisation des API

Un rapport d'utilisation d'API décrit un ensemble de références à partir d'un ensemble de regroupements vers un autre ensemble de regroupements. Un rapport peut être généré avec la tâche Ant d'utilisation des API. Une interface utilisateur est mise à disposition pour la configuration et la génération d'un rapport dans la boîte de dialogue Outils externes. Pour créer une configuration d'analyse d'utilisation, cliquez deux fois sur le type de configuration Rapport d'utilisation de l'API.

Onglet Rapport d'utilisation de l'API

L'onglet Rapport d'utilisation de l'API permet de configurer l'analyse.

L'exemple ci-dessous présente une configuration permettant d'extraire toutes les références à des regroupements Eclipse dans une installation 3.4.

Onglet Rapport d'utilisation de l'API


Option

Description

Valeur par défaut

Analyser Vous pouvez sélectionner les éléments à analyser : une version de référence d'API, une définition de cible ou un répertoire de regroupements. Vous pouvez aussi choisir de ne générer que du code HTML pour un rapport existant. De plus, vous ne pouvez sélectionner qu'une option, chacune permettant la configuration. En d'autres termes, vous pouvez accéder à la page de préférences Références d'API pour éditer les versions de référence existantes si vous choisissez d'analyser une version de référence d'API. Référence d'API
Analyser > Référence d'API Vous pouvez choisir d'analyser n'importe quelle référence d'API de la zone de liste déroulante. Référence par défaut ou vide
Analyser > Références... Permet d'accéder à la page de préférences Références d'API pour configurer la version de référence à analyser.  
Analyser > Définition de cible Vous pouvez choisir d'analyser n'importe quelle définition de cible de la zone de liste déroulante. Définition de cible active ou vide
Analyser > Cibles Permet d'accéder à la page de préférences Plateforme cible pour configurer la définition de cible à analyser.  
Analyser > Répertoire Vous pouvez entrer le chemin absolu d'un répertoire contenant les regroupements. Vide
Analyser > Parcourir... Permet de rechercher un dossier de regroupements à analyser.  
Analyser > Générer un rapport HTML pour l'analyse d'utilisation existante Permet de créer un rapport pour une analyse existante sans avoir à effectuer l'analyse à nouveau.  
Rechercher > Références à Permet de spécifier le nom (ou l'expression régulière correspondante) du regroupement pour lequel afficher les références. Considérez l'exemple suivant : org\.eclipse.*. Dans cet exemple, nous indiquons que nous voulons afficher toutes les références à tout regroupement dont le nom commence par org.eclipse.. Vide
Rechercher > Références d'API Permet de rechercher des références d'API. Non sélectionné
Rechercher > Références internes Permet de rechercher des références internes. Sélectionné
Rechercher > Utilisation d'API interdite Permet de rechercher les utilisations d'API interdites, c'est-à-dire les utilisations de membres d'API restreints. Non sélectionné
Rechercher dans > Regroupements correspondant à Permet de spécifier le nom (ou l'expression régulière correspondante) du ou des regroupements pour lesquels rechercher des références, c'est-à-dire une portée de recherche. Considérez l'exemple suivant : .*. Dans cet exemple, nous indiquons que nous voulons effectuer la recherche dans tous les regroupements dont le nom correspond à n'importe quelle séquence de caractères. Vous pouvez obtenir le même effet en laissant la zone vide. Vide
Génération de rapports > Type de rapport Permet de faire un choix entre les deux formats de rapport html. Si l'option Rapport des regroupements référencés (producteurs) est sélectionnée, le rapport répertorie tous les regroupements contenant les types référencés dans les regroupements recherchés. Si l'option Rapport des regroupements référençants (consommateurs) est sélectionnée, le rapport est organisé pour afficher tous les regroupements dans la portée de recherche qui contient les références.

Lors des changements de types de rapport, assurez-vous que les expressions régulières Références à et Regroupements correspondant à ont des valeurs correctes. Lorsqu'une expression de type caractère générique, comme .* est utilisée dans un paramètre, il est souvent nécessaire de déplacer ce dernier dans l'autre paramètre afin d'optimiser le rapport.

Rapport des regroupements référencés (producteurs)
Génération de rapports > Emplacement de la sortie du rapport Permet de spécifier le chemin absolu dans lequel les rapports générés doivent être placés. Vide
Génération de rapports > Parcourir... Permet de sélectionner l'emplacement de sortie des rapports.  
Génération de rapports > Nettoyer le répertoire des rapports avant de générer des rapports pour les nouveaux résultats Permet de nettoyer un emplacement de rapport XML existant avant que l'analyse ne génère de nouveaux résultats. Notez que cette option supprime complètement le répertoire de rapports spécifié s'il existe ainsi que tous les répertoires enfant, de façon récursive. non sélectionné
Génération de rapports > Créer des rapports HTML Convertit la sortie XML au format HTML et la place dans le répertoire <emplacement des rapports>\html non sélectionné
Génération de rapports > Nettoyer l'emplacement des rapports HTML Permet de nettoyer un emplacement HTML existant avant de créer de nouveaux rapports. Notez que cette option supprime complètement le répertoire HTML spécifié s'il existe ainsi que tous les répertoires enfant, de façon récursive. Cette option n'est activée que si vous sélectionnez l'option Créer des rapports HTML mentionnée plus haut. non sélectionné
Génération de rapports > Ouvrir le rapport une fois la recherche terminée Ouvre le rapport HTML une fois l'analyse terminée. Cette option n'est activée que si vous sélectionnez l'option Créer des rapports HTML mentionnée plus haut. non sélectionné
Génération de rapports > Description Permet d'entrer une description lisible du rapport. Vide

Onglet Modèles

L'onglet Modèles permet de créer différents modèles d'expression régulière permettant de contrôler l'analyse d'utilisation. Actuellement, il existe trois types de modèle :

  1. Modèle d'archive - permet de spécifier des archives imbriquées devant être ignorées lors de l'analyse.
  2. Modèle de package - permet de spécifier des packages de type API ou interne sans avoir à mettre à jour le manifeste du regroupement.
  3. Modèle de conversion de rapport - permet de créer une expression régulière de nom de package pour filtrer les références à afficher dans le rapport. Toutes les références figurant dans le rapport sont filtrées selon leur nom de package qualifié complet.

Onglet Modèles


Option

Description

Valeur par défaut

Ajouter Permet d'ajouter un nouveau modèle. Ce bouton ouvre l'assistant Modèle.  
Editer Permet d'éditer le modèle sélectionné. Vous ne pouvez éditer qu'un modèle à la fois.  
Supprimer Permet de supprimer le ou les modèles sélectionnés. Vous pouvez supprimer plusieurs modèles à la fois.  

Tâches connexes

Comparaison d'une référence d'API
Configuration d'une référence

Référence connexe

Préférences de référence d'API
Assistant des modèles d'utilisation d'API