com.github.dannil.scbjavaclient.client

Class SCBClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.AbstractContainerClient

com.github.dannil.scbjavaclient.client.SCBClient

public class SCBClient
extends AbstractContainerClient

Root client for the client hierarchy.

Since:

0.0.2

Field Summary

Fields inherited from class com.github.dannil.scbjavaclient.client.AbstractContainerClient

clients

Fields inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

locale, localization

Constructor Summary

Constructors

Constructor and Description
SCBClient() Default constructor.
SCBClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
EnvironmentClient	environment() Retrieve the client for interacting with environment data.
Map<String,Collection<String>>	getInputs(String table) Fetches all the inputs for a given table from the API.
String	getRawData(String table) Fetch the JSON response from the specified table.
String	getRawData(String table, Map<String,Collection<?>> query) Fetch the JSON response from the specified table.
static boolean	isSupportedLocale(Locale locale) Checks if the specified Locale is supported by the API.
PopulationClient	population() Retrieve the client for interacting with population data.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractContainerClient

setLocale

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

get, getBaseUrl, getLocale, getRegions, getUrl, getYears, post, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SCBClient

public SCBClient()

Default constructor. Initializes values and creates sub-clients.

SCBClient

public SCBClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the locale for this client

Method Detail

environment

public EnvironmentClient environment()

Retrieve the client for interacting with environment data.

Returns:

a client for environment data

population

public PopulationClient population()

Retrieve the client for interacting with population data.

Returns:

a client for population data

getInputs

public Map<String,Collection<String>> getInputs(String table)

Fetches all the inputs for a given table from the API.

Parameters:

table - the table to fetch the inputs from

Returns:

a collection of all codes and their respective values

See Also:

JsonAPITableFormat#getInputs()

getRawData

public String getRawData(String table)

Fetch the JSON response from the specified table. As opposed to getRawData(String, Map), this method fetches all available data and therefore doesn't support selecting specific values before calling the API.

Do note: as this method matches all content codes available on the API, the response is likely to be several times larger than the response when selecting values.

Parameters:

table - the table to fetch data from

Returns:

a JSON string containing all available data in the specified table

See Also:

JsonAPITableFormat#getValues(String)

getRawData

public String getRawData(String table,
                         Map<String,Collection<?>> query)

Fetch the JSON response from the specified table. Useful if you're only interested in the raw JSON data.

Parameters:

table - the table to fetch data from

query - the selected values

Returns:

a response from the API formatted as JSON

isSupportedLocale

public static boolean isSupportedLocale(Locale locale)

Checks if the specified Locale is supported by the API. The method performs a request to the API using the Locale's language and checks if a HTTP resource exists matching the language.

Parameters:

locale - the locale to check

Returns:

true if the locale is supported, otherwise false