uk.ac.starlink.hapi

Interface HapiCatalog

public interface HapiCatalog

Models the HAPI Catalog response object, as obtained from the catalog endpoint.

Since:

12 Jan 2024

See Also:

HAPI 3.1 sec 3.5

Method Summary

Modifier and Type	Method and Description
static HapiCatalog	fromJson(org.json.JSONObject json) Reads HapiCatalog from a JSON object, with structure defined by the HAPI catalog endpoint.
java.lang.String[]	getDatasetIds() Returns an array of dataset ID values in this catalog.
HapiVersion	getHapiVersion() Returns the protocol version.

Method Detail

getHapiVersion

HapiVersion getHapiVersion()

Returns the protocol version.

Returns:

version object, not null

getDatasetIds

java.lang.String[] getDatasetIds()

Returns an array of dataset ID values in this catalog.

Returns:

array of dataset IDs, not null

fromJson

static HapiCatalog fromJson(org.json.JSONObject json)

Reads HapiCatalog from a JSON object, with structure defined by the HAPI catalog endpoint.

Parameters:

json - JSON object

Returns:

catalog object, not null