Pacchetti libreria e classi chiave

Per un'introduzione ai corsi più utilizzati, vedi classi chiave.

Per un'introduzione ai pacchetti di librerie Java di origine dati, segui i link riportati di seguito:

• origine dati
• datasource.base
• datasource.datatable
• datasource.query
• datasource.render
• datasource.util

Corsi chiave

Le classi chiave sono DataSourceServlet, DataTable, Query e DataSourceHelper.

L'implementazione più semplice della libreria prevede l'ereditarietà da DataSourceServlet, la scrittura della tua implementazione di generateDataTable() e l'esecuzione dell'implementazione all'interno di un servlet. Questo tipo di implementazione è descritto nella sezione Per iniziare.

La classe DataTable definisce le colonne, i tipi di colonna, le etichette, gli ID e le proprietà personalizzate per una tabella di dati.

La classe Query è la classe base per le query sui dati e gestisce una query generata dalla visualizzazione.

Per casi d'uso più complessi, la classe helper DataSourceHelper offre un insieme di funzioni helper. Questo tipo di implementazione è descritto in Definizione delle funzionalità e flusso di eventi.

datasource

Questo è il pacchetto di primo livello e contiene le classi API con cui interagisce la maggior parte degli sviluppatori di origini dati.

A questo livello principale si trova anche Capabilities, utilizzato per definire le capabilities di query dell'origine dati.

base

Questo pacchetto contiene tutte le classi utilizzate da più di un pacchetto per evitare dipendenze circolari tra i pacchetti. Gli elementi più importanti sono i messaggi di errore che vengono impostati nella lingua predefinita dell'inglese americano. Per internazionalizzare la tua implementazione, dovrai tradurre questi messaggi.

datatable

Questo pacchetto contiene classi che gestiscono la struttura della tabella di dati (colonne, righe, celle) e le funzionalità (insert, add).

Questo pacchetto contiene anche il pacchetto value che gestisce i valori e i tipi di valori supportati dalla libreria. I tipi di valori disponibili sono definiti nell'enumerazione ValueType e includono: booleano, data, ora del giorno, data e ora, null, numero e testo. 

query

Questo pacchetto contiene classi che gestiscono le query. La classe base è Query. Questo pacchetto contiene anche i seguenti pacchetti:

• parser: classi che gestiscono l'analisi delle query.
  
• engine: classi che gestiscono l'esecuzione delle query.
• scalarfunction: classi che gestiscono le funzioni scalari usate in una query.

render

Questo pacchetto contiene le classi che formattano una risposta. Ad esempio:

• CsvRenderer esegue il rendering di una tabella di dati in formato CSV.
• HtmlRenderer esegue il rendering di una tabella di dati come HTML.
• JsonRenderer esegue il rendering di una tabella di dati in formato JSON.
• EscapeUtil fornisce un'utilità per l'interpretazione letterale delle stringhe.

util

Questo pacchetto fornisce due insiemi di funzioni helper:

• CsvDataSourceHelper e CsvDataSourceException forniscono funzioni helper per l'utilizzo di un file CSV come datastore, ma non forniscono un'implementazione completa di un'origine dati. Per un esempio di implementazione, consulta Utilizzo di un datastore esterno.
• SqlDataSourceHelper e SqlDatabaseDescription forniscono funzioni di supporto per l'utilizzo di un database MySQL come archivio dati, ma non forniscono un'implementazione completa di un'origine dati. Per un'implementazione di esempio, consulta SqlDataSourceServlet nel pacchetto examples.