# Package uk.ac.starlink.hapi

Classes for working with the HAPI (Heliophysics Data Application Programmer's Interface) protocol.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  HapiBins | Characterises the bins information of a HAPI parameter.
  HapiCapabilities | Models the HAPI Capabilities response object, as obtained from the capabilities endpoint.
  HapiCatalog | Models the HAPI Catalog response object, as obtained from the catalog endpoint.
  HapiInfo | Models the HAPI Info response object, as obtained from the info endpoint.
  HapiParam | Characterises a HAPI Parameter, that is the metadata for a column in a HAPI dataset.

- Class Summary
  Class | Description
  --- | ---
  ChunkStreamer | Handles reading HAPI data streams in chunks to cope with data requests that encounter service errors with the status 1408 "Bad Status - too much time or data requested".
  CsvReader | CSV file reader.
  DateRangePanel | Graphical component for selecting a time range.
  FilterListModel<T> | ListModel that allows filtering the content by matching to the content of a text field.
  HapiBrowser | GUI component that displays metadata from available HAPI services.
  HapiService | Encapsulates an HTTP(S) URL that serves the HAPI protocol.
  HapiSource | Knows how to load a HAPI table.
  HapiTableBuilder | TableBuilder implementation for HAPI data streams.
  HapiTableLoadDialog | TableLoadDialog for working with HAPI services.
  HapiTableReader | Converts HAPI metadata and input streams to StarTables.
  HapiTableScheme | TableScheme implementation for interacting with HAPI services.
  HapiType<S,A> | Data type for a HAPI parameter.
  HapiVersion | Characterises the version of the HAPI protocol in use.
  ParamReader | Reads values specified by a particular parameter from a HAPI data stream.
  ServerListing | Listing for HAPI services.
  ServerMeta | Describes basic information about a HAPI server.
  ServicePanel | Displays and allows selection of metadata for a HAPI service.
  SlideDateRanger | Graphical time range selector component.
  Times | Utilities for manipulating time values.

- Enum Summary
  Enum | Description
  --- | ---
  HapiEndpoint | Programmatic endpoints defined by the HAPI protocol.

- Exception Summary
  Exception | Description
  --- | ---
  HapiServiceException | IOException subclass that is known to arise from a HAPI service error with a HAPI-specific status code.

## Package uk.ac.starlink.hapi Description

Classes for working with the HAPI (Heliophysics Data Application Programmer's Interface) protocol. These were written with reference to the v3.1 specification but are expected to be suitable for use with any v2.x or v3.x HAPI services.

Since:
  11 Jan 2024
See Also:
  HAPI Specification