Pakiety biblioteczne i klasy kluczy

Informacje o najczęściej używanych klasach znajdziesz w artykule na temat klas kluczy.

Aby zapoznać się z wprowadzeniem do pakietów bibliotek Javy dla źródła danych, kliknij te linki:

Klasy kluczy

Kluczowe klasy to DataSourceServlet, DataTable, Query i DataSourceHelper.

Najprostsza implementacja biblioteki obejmuje dziedziczenie z tagu DataSourceServlet, napisanie własnej implementacji obiektu generateDataTable(), a następnie uruchomienie jej w serwletze. Ten typ implementacji opisano w sekcji Pierwsze kroki.

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

Klasa Query jest klasą bazową dla zapytań o dane i obsługuje zapytanie wygenerowane przez wizualizację.

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

datasource

Jest to pakiet najwyższego poziomu i zawiera klasy API, z którymi większość deweloperów źródeł danych wchodzi w interakcje.

Na tym najwyższym poziomie znajduje się też Capabilities, który służy do określania capabilities zapytań dotyczących źródła danych.

base

Ten pakiet zawiera wszystkie klasy, które są używane przez więcej niż 1 pakiet, aby zapobiec zapętlonym zależnościom między pakietami. Najważniejsze są komunikaty o błędach wyświetlane w domyślnym języku angielskim (USA). Aby internacjonalizować implementację, trzeba będzie przetłumaczyć komunikaty.

datatable

Ten pakiet zawiera klasy obsługujące strukturę tabeli danych (kolumny, wiersze, komórki) i funkcje (insert, add).

Ten pakiet zawiera również pakiet value, który obsługuje wartości i typy wartości obsługiwane przez bibliotekę. Dostępne typy wartości są zdefiniowane na liście ValueType i obejmują: wartość logiczna, data, pora dnia, data i godzina, wartość null, liczba i tekst. 

query

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

  • parser – klasy, które obsługują analizę zapytania.
  • engine – klasy, które obsługują wykonywanie zapytań.
  • scalarfunction – klasy obsługujące funkcje skalarne używane w zapytaniu.

render

Ten pakiet zawiera klasy, które formatują odpowiedź. Na przykład:

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

util

Ten pakiet zawiera 2 zestawy funkcji pomocniczych:

  • CsvDataSourceHelper i CsvDataSourceException udostępniają funkcje pomocnicze umożliwiające wykorzystanie pliku CSV jako magazynu danych, ale nie zapewniają pełnej implementacji źródła danych. Przykłady implementacji znajdziesz w artykule Korzystanie z zewnętrznego magazynu danych.
  • SqlDataSourceHelper i SqlDatabaseDescription udostępniają funkcje pomocnicze umożliwiające użycie bazy danych MySQL jako magazynu danych, ale nie zapewniają pełnej implementacji źródła danych. Przykład implementacji znajdziesz w sekcji SqlDataSourceServlet w pakiecie examples.