Pakiety bibliotek i klasy kluczy

Informacje o najczęściej używanych klasach znajdziesz w artykule klasy klucza.

Aby uzyskać informacje o pakietach biblioteki Java w źródle danych, kliknij te linki:

Najważniejsze klasy

Najważniejsze klasy to DataSourceServlet, DataTable, Query i DataSourceHelper.

Najprostsza implementacja biblioteki obejmuje dziedziczenie z DataSourceServlet, napisanie własnej implementacji generateDataTable() i uruchomienie jej w serwletu. Ten typ implementacji opisano w sekcji Pierwsze kroki.

Klasa DataTable określa kolumny, typy kolumn, etykiety, identyfikatory i właściwości niestandardowe tabeli danych.

Klasa Query jest podstawową klasą dla zapytań o dane, obsługuje ona zapytania generowane przez wizualizację.

W bardziej złożonych przypadkach klasa pomocnicza DataSourceHelper udostępnia zestaw funkcji pomocniczych. Ten typ implementacji opisano w artykule Definiowanie możliwości i przepływ zdarzeń.

datasource

Jest to pakiet najwyższego poziomu zawierający klasy interfejsu API, z którymi współpracuje większość deweloperów źródeł danych.

Na najwyższym poziomie znajduje się też Capabilities, który służy do określania możliwości źródła danych.

base

Ten pakiet zawiera wszystkie klasy używane przez więcej niż 1 pakiet, aby zapobiec zależnościom cyklicznym między pakietami. Najbardziej znane elementy to komunikaty o błędach w domyślnym języku angielskim (USA). Aby wdrożyć ten interfejs w różnych językach, musisz przetłumaczyć te komunikaty.

datatable

Ten pakiet zawiera klasy obsługujące strukturę tabel danych (kolumny, wiersze, komórki) i funkcje (wstaw, dodaj).

Ten pakiet zawiera też pakiet value, który obsługuje wartości i typy wartości obsługiwane przez bibliotekę. Dostępne typy wartości są określone w obliczeniu ValueType i zawierają wartość logiczną, datę, godzinę, datę i godzinę, wartość null, liczbę i tekst. 

query

Ten pakiet zawiera klasy obsługujące zapytania. Klasa podstawowa to Query. Ten pakiet zawiera też te pakiety:

  • parser – klasy obsługujące analizę składni zapytań.
  • engine – klasy obsługujące wykonywanie zapytań.
  • scalarfunction – klasy obsługujące funkcje skalarne używane w zapytaniu.

render

Ten pakiet zawiera klasy formatujące odpowiedź. Przykład:

  • CsvRenderer renderuje tabelę danych jako plik CSV.
  • HtmlRenderer renderuje tabelę danych jako plik HTML.
  • JsonRenderer renderuje tabelę danych jako JSON.
  • EscapeUtil zawiera narzędzie do zmiany znaczenia ciągów znaków.

util

Ten pakiet zawiera 2 zestawy funkcji pomocniczych:

  • CsvDataSourceHelper i CsvDataSourceException zapewniają funkcje pomocnicze w zakresie używania pliku CSV jako bazy danych, nie stanowią one pełnej implementacji źródła danych. Przykład implementacji znajdziesz w artykule Korzystanie z zewnętrznego magazynu danych.
  • SqlDataSourceHelper i SqlDatabaseDescription udostępniają funkcje pomocnicze, które umożliwiają korzystanie z bazy danych mySQL jako bazy danych. Nie udostępniają one pełnej implementacji źródła danych. Przykład implementacji znajdziesz w opisie SqlDataSourceServlet w pakiecie examples.