Relatórios de Uso da API

Um Relatório de Uso da API descreve um conjunto de referências de um conjunto de pacotes configuráveis para outro conjunto de pacotes configuráveis. Um relatório pode ser gerado usando a Tarefa Ant de Uso da API. Uma interface com o usuário é fornecida para configurar e gerar um relatório no diálogo Ferramentas Externas. Para criar uma nova configuração de varredura, basta clicar duas vezes no tipo de configuração Relatório de Uso da API.

Guia Relatório de Uso da API

A guia Relatório de Uso da API permite configurar a análise.

O exemplo a seguir mostra uma configuração para extrair todas as referências para os pacotes configuráveis do Eclipse em uma instalação 3.4.

Guia Relatório de Uso da API


Opção

Descrição

Padrão

Analisar Você pode selecionar o que deseja analisar, que pode ser uma linha de base da API, uma definição de destino ou um diretório de pacotes configuráveis. Também é possível selecionar para somente gerar HTML para um relatório existente. É possível selecionar somente uma opção e cada opção pode permitir que você a configure. Isto é, você poderá acessar a página de preferências de linhas de base da API para editar as linhas de base existentes se optar por analisar uma linha de base da API. Linha de Base de API
Analisar > Linha de Base de API É possível escolher qualquer linha de base da API na caixa de combinação para análise A linha de base padrão ou vazia
Analisar > Linhas de Base... Permite acessar a página de preferências Linhas de Base de API para configurar a linha de base a ser analisada.  
Analisar > Definição de Destino É possível escolher qualquer definição de destino da caixa de combinação para análise A definição de destino ativa ou vazia
Analisar > Destinos Permite acessar a página de preferências Plataforma de Destino para configurar a definição de destino a ser analisada.  
Analisar > Diretório É possível inserir o caminho absoluto para um diretório que contém os pacotes configuráveis. empty
Analisar > Procurar... Permite procurar uma pasta de pacotes configuráveis a serem analisados.  
Analisar > Gerar relatório HTML para a varredura de uso existente Permite criar um relatório para uma varredura existente e não precisa executar a análise novamente.  
Procurar > Referências a Permite especificar o nome (ou o RegEx correspondente) do pacote configurável que você deseja ver referências. Considere o seguinte exemplo: org\.eclipse.*. Neste exemplo, estamos dizendo que desejamos ver todas as referências feitas a qualquer pacote configurável que inicie com o nome org.eclipse.. empty
Procurar > Referências de API Permite verificar se há referências de API. unchecked
Procurar > Referências Internas Permite verificar se há referências internas. checked
Procurar > Uso de API Ilegal Permite verificar se há uso de API ilegal, isto é, uso de membros restritos da API. unchecked
Procurar em > Correspondência de Pacotes Configuráveis Permite especificar o nome (ou o RegEx correspondente) do pacote configurável que você deseja ver referências; isto é, um escopo da procura. Considere o seguinte exemplo: .*. Neste exemplo, estamos dizendo que desejamos procurar em todos os pacotes configuráveis em que o nome corresponde a qualquer sequência de caracteres. Deixar o campo em branco resulta no mesmo efeito. empty
Relatório > Tipo de Relatório Permite escolher entre dois formatos de relatórios HTML. Se Relatório de pacotes configuráveis referenciados (Produtores) estiver selecionado, o relatório listará todos os pacotes configuráveis contendo os tipos que estão sendo referenciados nos pacotes configuráveis procurados. Se Relatório de pacotes configuráveis referenciados (Consumidores) estiver selecionado, o relatório será organizado para mostrar todos os pacotes configuráveis no escopo da procura que contém referências.

Ao alternar tipos de relatórios, verifique se as expressões regulares Referencia a e Correspondência de pacotes configuráveis possuem os valores corretos. Ao usar uma expressão curinga como .* em uma configuração, a alternância para outro tipo de relatório frequentemente exige o curinga que está sendo movido para outra configuração para obter o relatório mais útil.

Relatório de pacotes configuráveis referenciado (Produtores)
Relatório > Local de Saída de Relatório Permite especificar o caminho absoluto onde devem ser colocados todos os relatórios gerados. empty
Relatório > Procurar... Permite selecionar o local para a saída de qualquer relatório.  
Relatório > Limpar diretório de relatório antes de relatar novos resultados Permite limpar um local de relatório XML existente antes da varredura relatar qualquer resultado. Observe que esta opção removerá completamente o diretório de relatórios especificado se ele existir, com todos os diretórios filhos sendo recursivamente removidos também. unchecked
Relatório > Criar Relatórios HTML Converte toda a saída XML em HTML formatado e a coloca em <report location>\html unchecked
Relatório > Limpar local do relatório HTML Permite limpar um local de HTML existente antes de criar novos relatórios. Observe que esta opção removerá completamente o diretório HTML especificado se ele existir, com todos os diretórios filhos sendo recursivamente removidos também. Esta opção será ativada somente se você selecionar a opção Criar Relatórios HTML mencionada acima. unchecked
Relatório > Abrir relatório ao concluir a procura Abre o relatório HTML quando a análise é concluída. Esta opção será ativada somente se você selecionar a opção Criar Relatórios HTML mencionada acima. unchecked
Relatório > Descrição Permite inserir uma descrição legível para o relatório. empty

Guia Padrões

A guia Padrões permite criar vários padrões de Expressão Regular para controlar a análise de uso. Atualmente, há três tipos de padrões suportados:

  1. Padrão de Archive - Permite especificar archives aninhados que devem ser ignorados durante a análise.
  2. Padrão de Pacote - Permite especificar pacotes que devem ser API ou internos sem atualizar seu manifesto do pacote configurável.
  3. Padrão de Conversão de Relatório - Permite que você crie uma expressão regular de nome de pacote para filtrar as referências que serão relatadas. Todas as referências relatadas são filtradas usando seu nome completo de pacote.

Guia Padrões


Opção

Descrição

Padrão

Incluir... Permite incluir um novo padrão. Esse botão iniciará o Assistente de Padrão.  
Editar Permite editar o padrão selecionado atualmente. Somente um padrão pode ser editado por vez.  
Remover Permite remover o(s) padrão(ões) selecionado(s). É possível remover mais de um padrão por vez.  

Tarefas relacionadas

Comparando a uma Linha de Base da API
Configurando uma Linha de Base

Referência relacionada

Preferências de Linhas de Base de API
Assistente de Padrões de Uso da API