Pacotes de bibliotecas e classes de chaves

Para ver uma introdução às classes mais usadas, consulte classes principais.

Para uma introdução aos pacotes de biblioteca Java da fonte de dados, siga 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, gravando sua própria implementação de generateDataTable() e executando a implementação em um servlet. Esse tipo de implementação é descrito na seção Primeiros passos.

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

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

Para casos de uso mais complexos, a classe auxiliar DataSourceHelper fornece 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 superior está Capabilities, que é usado para definir os recursos 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, será necessário traduzir essas mensagens.

datatable

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

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

query

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

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

render

Esse 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.
• EscapeUtil fornece um utilitário para escapar strings.

util

Este pacote fornece dois conjuntos de funções auxiliares:

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