Per un'introduzione alle classi più utilizzate, consulta le classi chiave.
Per un'introduzione ai pacchetti della libreria Java dell'origine dati, segui i link riportati di seguito:
Classi chiave
Le classi chiave sono DataSourceServlet
, DataTable
, Query
e DataSourceHelper
.
L'implementazione più semplice della libreria prevede l'ereditarietà da DataSourceServlet
, scrivendo la tua implementazione di generateDataTable()
ed eseguendo l'implementazione all'interno di un servlet. Questo tipo di implementazione è descritto nella sezione Per iniziare.
La classe DataTable
definisce le colonne, i tipi di colonne, 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
fornisce un insieme di funzioni helper. Questo tipo di implementazione è descritto in Definizione delle funzionalità e del flusso di eventi.
datasource
Si tratta del pacchetto di primo livello e contiene le classi API con cui interagiscono la maggior parte degli sviluppatori dell'origine dati.
A questo livello principale si trova anche Capabilities
, che viene utilizzato per definire le funzionalità 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 nelle impostazioni internazionali predefinite dell'inglese americano. Per internazionalizzare la tua implementazione, dovrai tradurre questi messaggi.
datatable
Questo pacchetto contiene classi che gestiscono la struttura della tabella dati (colonne, righe, celle) e le funzionalità (inserisci, aggiungi).
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 di 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
.
Il 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 utilizzate in una query.
render
Questo pacchetto contiene le classi che formattano una risposta. Ad esempio:
CsvRenderer
visualizza una tabella di dati in formato CSV.HtmlRenderer
visualizza una tabella di dati in HTML.JsonRenderer
visualizza una tabella di dati come JSON.EscapeUtil
offre un'utilità per l'escape delle stringhe.
util
Questo pacchetto fornisce due insiemi di funzioni helper:
CsvDataSourceHelper
eCsvDataSourceException
forniscono funzioni helper per l'utilizzo di un file CSV come datastore; non forniscono un'implementazione completa di un'origine dati. Per un esempio di implementazione, consulta l'articolo Utilizzo di un datastore esterno.SqlDataSourceHelper
eSqlDatabaseDescription
forniscono funzioni helper per l'utilizzo di un database mySQL come datastore, non forniscono un'implementazione completa di un'origine dati. Per un'implementazione di esempio, consultaSqlDataSourceServlet
nel pacchettoexamples
.