Informes de Utilización de API

Un Informe de utilización de API describe un conjunto de referencias de un conjunto de paquetes a otro conjunto de paquetes. Se puede generar un informe mediante la tarea Ant Utilización de API. Se proporciona una interfaz de usuario para configurar y generar un informe en el diálogo Herramientas externas. Para crear una configuración de exploración de utilización nueva, simplemente efectúe una doble pulsación sobre el tipo de configuración de Informe de utilización de API.

Pestaña Informe de utilización de API

La pestaña Informe de utilización de API permite configurar el análisis.

El ejemplo siguiente muestra una configuración para extraer todas las referencias a paquetes de Eclipse en una instalación de 3.4.

Pestaña Informe de utilización de API


Opción

Descripción

Valor predeterminado

Analizar Puede seleccionar lo que desea analizar, que puede ser una línea base de API, una definición de destino o un directorio de paquetes. También puede seleccionar generar sólo HTML para un informe existente. Sólo puede seleccionar una opción para su configuración. Es decir, puede ir a la página de preferencias de líneas base de API para editar líneas base existentes si selecciona analizar una línea base de API. Línea base de API
Analizar > Línea base de API Puede elegir cualquier línea base de API del recuadro combinado para analizar. Línea base predeterminada o vacía
Analizar > Líneas base... Permite el acceso a la página de preferencias Líneas base de API para configurar la línea base a analizar.  
Analizar > Definición de destino Puede elegir cualquier definición de destino en el cuadro combinado para su análisis La definición de destino activa o vacía
Analizar > Destinos Permite el acceso a la página de preferencias Plataforma de destino para configurar la definición a analizar.  
Analizar > Directorio Puede especificar la vía de acceso absoluta a un directorio que contenga los paquetes. vacío
Analizar > Examinar... Permite examinar en busca de una carpeta de paquetes a analizar.  
Analizar > Generar un informe HTML para la exploración de utilización existente Permite crear un informe para una exploración existente y no tener que volver a realizar el análisis.  
Buscar > Referencias a Permite especificar el nombre (o el RegEx coincidente) del paquete para el que quiere ver las referencias. Tenga en cuenta el ejemplo siguiente: org\.eclipse.*. En este ejemplo estamos diciendo que queremos ver todas las referencias a cualquier paquete que empiece por org.eclipse.. vacío
Buscar > Consultas de API Permite explorar en busca de consultas de API. no seleccionado
Buscar > Referencias internas Permite explorar en busca de referencias internas. seleccionado
Buscar > Utilización de API no permitida Permite explorar en busca de utilizaciones de API no permitidas, es decir de utilizaciones de miembros de API restringidos. no seleccionado
Buscar en > Paquetes coincidentes Permite especificar el nombre (o el RegEx coincidente) de los paquetes que desea explorar en busca de referencias de un ámbito de búsqueda. Tenga en cuenta el ejemplo siguiente: .*. En este ejemplo estamos diciendo que queremos buscar en todos los paquetes cuyo nombre coincida con cualquier secuencia de caracteres. El mismo efecto se puede conseguir dejando el campo en blanco. vacío
Creación de informes > Tipo de informe Le permite escoger entre dos formatos de informe html. Si la opción Informe de paquetes referidos (Productores) está seleccionada, el informe enumerará todos los paquetes que incluyan los tipos referidos en los paquetes buscados. Si la opción Informe de paquetes referidos (Consumidores), el informe estará organizado para mostrar todos los paquetes del ámbito de búsqueda que contengan referencias.

Al conmutar de un tipo de informe a otro, compruebe que las expresiones regulares Referencias a y Paquetes coincidentes tienen los valores correctos. Al utilizar una expresión comodín como .* en un valor, para conmutar a otro tipo de valor generalmente tendrá que mover el comodín al otro valor que obtener el informe más útil.

Informe de paquetes referidos (Productores)
Creación de informes > Ubicación de salida de informe Permite especificar la vía de acceso absoluta en la que se deben colocar los informes generados. vacío
Creación de informes > Examinar... Permite seleccionar la ubicación para sacar informes.  
Creación de informes > Borrar el directorio de informe antes de informar de resultados nuevos Permite borrar una ubicación de informe XML existente antes de explorar creando informes de resultados. Debe tener en cuenta que esta opción eliminará completamente el directorio de informe especificado si existe y consiguientemente todos los directorios hijo. no seleccionado
Creación de informes > Crear informes HTML Convierte toda la salida XML en HTML formateado y lo coloca en <ubicación del informe>\html no seleccionado
Creación de informes > Borrar la ubicación de informe HTML Permite borrar una ubicación HTML existente antes de crear informes nuevos. Debe tener en cuenta que esta opción eliminará completamente el directorio HTML especificado si existe y consiguientemente todos los directorios hijo. Esta opción sólo está habilitada si selecciona la opción Crear informes HTML mencionada más arriba. no seleccionado
Creación de informes > Abrir el informe cuando finaliza la búsqueda Abre el informe HTML cuando el análisis ha finalizado. Esta opción sólo está habilitada si selecciona la opción Crear informes HTML mencionada más arriba. no seleccionado
Creación de informes > Descripción Permite especificar una descripción legible para el informe. vacío

Pestaña Patrones

La pestaña Patrones permite crear varios patrones de Expresión regular para controlar el análisis de la utilización. Actualmente hay tres especies de patrones soportadas:

  1. Patrón de archivador: permite especificar archivadores anidados que se deben ignorar durante el análisis.
  2. Patrón de paquete: permite especificar paquetes que debe ser API o internos sin tener que actualizar su manifiesto de paquetes.
  3. Patrón de conversión de informe: permite crear una expresión regular de nombre de paquete para filtrar referencias de las que se informa. Todas la referencias de las que se informa se filtran mediante el nombre de paquete totalmente calificado correspondiente.

Pestaña Patrones


Opción

Descripción

Valor predeterminado

Añadir... Le permite añadir un patrón nuevo. Est botón iniciará el asistente Patrón.  
Editar Permite editar el patrón seleccionado actualmente. Sólo se puede editar un patrón a la vez.  
Eliminar Permite eliminar los patrones seleccionados. Puede eliminar más de un patrón a la vez.  

Tareas relacionadas

Comparar con una línea base de API
Configurar una línea base

Consulta relacionada

Preferencias de líneas base de API
Asistente Patrones de utilización de API