Relat�rios de Utiliza��o da API

Um Relat�rio de Utiliza��o da API descreve um conjunto de refer�ncias de um conjunto de agrupamentos para outro conjunto de agrupamentos. Um relat�rio pode ser gerado utilizando Tarefa Ant de Utiliza��o da API. Uma interface de utilizador � fornecida para configurar e gerar um relat�rio na caixa de di�logo Ferramentas Externas. Para criar uma nova configura��o de pesquisa basta fazer duplo clique no tipo de configura��o Relat�rio de Utiliza��o da API.

Separador Relat�rio de utiliza��o da API

O separador Relat�rio de utiliza��o da API permite configurar a an�lise.

O exemplo seguinte mostra uma configura��o para extrair todas as refer�ncias para agrupamentos Eclipse numa instala��o 3.4.

Separador Relat�rio de Utiliza��o da API


Op��o

Descri��o

Predefini��o

Analisar � poss�vel seleccionar o que pretende analisar: uma linha de base da API, uma defini��o de destino ou um direct�rio de lotes. Pode igualmente seleccionar gerar apenas HTML para um relat�rio existente. Pode seleccionar somente uma op��o, podendo configurar cada op��o. Por exemplo, pode ir � p�gina de prefer�ncias de linhas de base da API para editar linhas de base se seleccionar analisar uma linha de base da API. Linha de base da API
Analisar > Linha de base da API Pode escolher na caixa de combina��o qualquer uma das linhas de base a analisar Linha de base predefinida ou vazia
Analisar > Linhas de base... Permite acesso � p�gina de prefer�ncias de Linhas de base da API para configurar a linha de base a analisar.  
Analisar > Defini��o de destino Pode escolher na caixa de combina��o qualquer uma das defini��es de destino a analisar Para activar a defini��o de destino ou vazio
Analisar > Destinos Permite acesso � p�gina de prefer�ncias de Plataforma destino para configurar a defini��o de destino a analisar.  
Analisar > Direct�rio Pode introduzir o caminho absoluto para o direct�rio que cont�m os lotes. vazio
Analisar > Navegar... Permite navegar por uma pasta de lotes a analisar.  
Analisar > Gerar relat�rio HTML para pesquisa de utiliza��o existente Permite criar um relat�rio para uma pesquisa existente e n�o ter de executar a an�lise novamente.  
Pesquisar > Refer�ncias a Permite especificar o nome (ou RegEx correspondente) do lote em que pretende ver refer�ncias a. Considere o exemplo seguinte: org\.eclipse.*. Neste exemplo, declaramos que pretendemos ver todas as refer�ncias a qualquer lote que comece pelo nome org.eclipse.. vazio
Pesquisar > Refer�ncias a API Permite pesquisar refer�ncias a API. n�o marcado
Pesquisar > Refer�ncias internas Permite pesquisar refer�ncias internas. marcado
Pesquisar > Utiliza��o ilegal da API Permite pesquisar a utiliza��o ilegal da API, isto �, a utiliza��o de membros da API restritos. n�o marcado
Pesquisar > Lotes correspondentes Permite especificar o nome (ou RegEx correspondente) do lote(s) em que pretende pesquisar refer�ncias, isto �, um �mbito de pesquisa. Considere o exemplo seguinte: .*. Neste exemplo, declaramos que pretendemos ver todos os lotes cujo nome corresponda a qualquer sequ�ncia de caracteres. Pode ser conseguido o mesmo resultado deixando o campo em branco. vazio
Criar relat�rios > Relat�rio de localiza��o de sa�da Permite especificar o caminho absoluto em que quaisquer relat�rios gerados dever�o ser colocados. vazio
Criar relat�rios > Navegar... Permite seleccionar a localiza��o de sa�da de quaisquer relat�rios.  
Criar relat�rios > Limpar direct�rio de relat�rios antes de comunicar novos resultados Permite limpar uma localiza��o de relat�rios XML existente antes de a pesquisa comunicar resultados. Deve ser tido em conta que esta op��o ir� remover totalmente o direct�rio de relat�rios especificado caso exista, incluindo tamb�m todos os seus direct�rios descendentes. n�o marcado
Criar relat�rios > Criar relat�rios HTML Converte todas as sa�das em XML para HTML formatado e coloca-as em <report location>\html n�o marcado
Criar relat�rios > Limpar localiza��o de relat�rios HTML Permite limpar uma localiza��o de HTML antes de criar relat�rios novos. Deve ser tido em conta que esta op��o ir� remover completamente o direct�rio de HTML caso exista, incluindo tamb�m todos os seus direct�rios descendentes. Esta op��o � activada apenas se seleccionar a op��o Criar relat�rios HTML acima referida. n�o marcado
Criar relat�rios > Abrir relat�rio quando pesquisa terminar Abre o relat�rio HTML quando a an�lise � conclu�da. Esta op��o � activada apenas se seleccionar a op��o Criar relat�rios HTML acima referida. n�o marcado
Criar relat�rios > Descri��o Permite introduzir uma descri��o leg�vel do relat�rio. vazio

Separador Padr�es

O separador Padr�es permite criar v�rios padr�es de Express�o regular para controlar a an�lise de utiliza��o. Existem actualmente tr�s tipos de padr�es suportados:

  1. Padr�o de arquivos - Permite especificar arquivos imbricados que dever�o ser ignorados durante a an�lise.
  2. Padr�o de pacotes - Permite especificar pacotes que dever�o ser API ou internos sem ter de actualizar o manifesto de lotes.
  3. Padr�o de convers�o de relat�rios - Permite criar um pacote de express�o regular de nome para filtrar refer�ncias que s�o comunicadas em relat�rios. Todas as refer�ncias comunicadas em relat�rios s�o filtradas utilizando o seu nome de pacote absolutamente qualificado.

Separador Padr�es


Op��o

Descri��o

Predefini��o

Adicionar... Permite adicionar um novo padr�o. Este bot�o ir� iniciar o assistente Assistente Padr�es.  
Editar Permite editar o padr�o actualmente seleccionado. S� pode editar um padr�o de cada vez.  
Remover Permite remover os padr�es seleccionados. Pode remover mais do que um padr�o de uma s� vez.  

Tarefas relacionadas

Comparar com uma linha de base da API
Configurar uma linha de base

Refer�ncias relacionadas

Prefer�ncias de linhas de base da API
Assistente de padr�es de utiliza��o da API