com.github.dannil.scbjavaclient.client

Class AbstractClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

Direct Known Subclasses:

AbstractContainerClient, EnvironmentLandAndWaterAreaClient, PopulationAmountClient, PopulationAverageAgeClient, PopulationDemographyClient, PopulationDensityClient, PopulationLiveBirthsClient, PopulationNameStatisticsClient, PopulationPartnershipClient

public abstract class AbstractClient
extends Object

Abstract class which specifies how clients should operate.

Author:

Daniel Nilsson

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	locale
protected Localization	localization

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClient() Default constructor.
protected	AbstractClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
protected String	get(String table) Performs a GET request to the specified table.
protected String	getBaseUrl() Determines the base URL for the API based on the current Locale.
Locale	getLocale() Retrieves the Locale for this client instance.
List<String>	getRegions(String table) Returns the list of the available regions for a given table.
String	getUrl() Returns the URL endpoint which this client represents.
List<String>	getYears(String table) Returns the list of the available years for a given table.
protected String	post(String table, String query) Performs a POST request to the specified table.
void	setLocale(Locale locale) Sets the Locale for this client instance.
void	setLocalizationLocale(Locale locale) Changes the Locale used for the localization.

Methods inherited from class java.lang.Object

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

Field Detail

locale

protected Locale locale

localization

protected Localization localization

Constructor Detail

AbstractClient

protected AbstractClient()

Default constructor.

AbstractClient

protected AbstractClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLocale

public Locale getLocale()

Retrieves the Locale for this client instance.

Returns:

the Locale for this client instance

setLocale

public void setLocale(Locale locale)

Sets the Locale for this client instance. Note that doing this after a call to setLocalizationLocale(Locale) overwrites the localization language with the input of this method.

Parameters:

locale - the Locale for this client

setLocalizationLocale

public void setLocalizationLocale(Locale locale)

Changes the Locale used for the localization. Useful if the client needs to be in a different language than the error messages.

Parameters:

locale - the Locale for the localization

getBaseUrl

protected String getBaseUrl()

Determines the base URL for the API based on the current Locale.

Returns:

the URL representing the entry point for the API

get

protected String get(String table)

Performs a GET request to the specified table.

Parameters:

table - the table which will be sent a GET request

Returns:

a string representation of the API's response

post

protected String post(String table,
                      String query)

Performs a POST request to the specified table.

Parameters:

table - the table which will be sent a POST request

query - the query which the API will process

Returns:

a string representation of the API's response

getRegions

public List<String> getRegions(String table)

Returns the list of the available regions for a given table.

Parameters:

table - the table to retrieve the regions from

Returns:

a list of the available regions for the given table or null if the table doesn't have regions

getYears

public List<String> getYears(String table)

Returns the list of the available years for a given table.

Parameters:

table - the table to retrieve the years from

Returns:

a list of the available years for the given table or null if the table doesn't have years

getUrl

public String getUrl()

Returns the URL endpoint which this client represents.

Returns:

the URL endpoint for this client