Pacotes de biblioteca e classes principais

Para ver uma introdução às classes mais usadas, consulte as classes de chave.

Para uma introdução aos pacotes da biblioteca Java de origem de dados, acesse os links abaixo:

• fonte de dados
• datasource.base
• datasource.datatable
• datasource.query
• datasource.render
• datasource.util

Principais classes

As classes principais são DataSourceServlet, DataTable, Query e DataSourceHelper.

A implementação mais simples da biblioteca envolve herdar de DataSourceServlet, escrever sua própria implementação de generateDataTable() e executá-la em um servlet. Esse tipo de implementação é descrito na seção Primeiros passos.

A classe DataTable define colunas, tipos de coluna, rótulos, IDs e propriedades personalizadas para uma tabela de dados.

A classe Query é a classe de base para consultas de dados. Ela processa uma consulta gerada por visualização.

Para casos de uso mais complexos, a classe auxiliar DataSourceHelper oferece um conjunto de funções auxiliares. Esse tipo de implementação é descrito em Como definir recursos e o fluxo de eventos.

datasource

Esse é o pacote de nível superior e contém as classes de API com que a maioria dos desenvolvedores de fontes de dados interage.

Também nesse nível está o Capabilities, que é usado para definir os capabilities de consulta da fonte de dados.

base

Este pacote contém todas as classes usadas por mais de um pacote para evitar dependências circulares entre os pacotes. Os itens mais importantes são mensagens de erro na localidade padrão do inglês americano. Para internacionalizar sua implementação, você precisará traduzir essas mensagens.

datatable

Este pacote contém classes que processam a estrutura da tabela de dados (colunas, linhas, células) e a funcionalidade (inserir, adicionar).

Esse pacote também contém o pacote value, que processa valores e tipos de valor com suporte da biblioteca. Os tipos de valor disponíveis são definidos na enumeração ValueType e incluem: booleano, data, hora do dia, data e hora, nulo, número e texto. 

query

Este pacote contém classes que processam consultas. A classe de base é Query. Este pacote também contém os seguintes pacotes:

• parser: classes que processam a análise de consulta.
  
• engine: classes que processam a execução da consulta.
• scalarfunction: classes que processam funções escalares usadas em uma consulta.

render

Este pacote contém as classes que formatam uma resposta. Exemplo:

• CsvRenderer renderiza uma tabela de dados como CSV.
• HtmlRenderer renderiza uma tabela de dados como HTML.
• JsonRenderer renderiza uma tabela de dados como JSON.
• O EscapeUtil fornece um utilitário para o escape de strings.

util

Este pacote (link em inglês) oferece dois conjuntos de funções auxiliares:

• CsvDataSourceHelper e CsvDataSourceException fornecem funções auxiliares para usar um arquivo CSV como armazenamento de dados, mas não fornecem uma implementação completa de uma fonte de dados. Para ver um exemplo de implementação, consulte Como usar um armazenamento de dados externo.
• SqlDataSourceHelper e SqlDatabaseDescription fornecem funções auxiliares para usar um banco de dados mySQL como armazenamento de dados, mas não fornecem uma implementação completa de uma fonte de dados. Para conferir um exemplo de implementação, consulte SqlDataSourceServlet no pacote examples.