com.github.dannil.scbjavaclient.client

Class AbstractClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

Direct Known Subclasses:

AbstractContainerClient, EnvironmentLandAndWaterAreaClient, PopulationDemographyClient, PopulationNameStatisticsClient, PopulationStatisticsClient

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
protected QueryBuilder	queryBuilder

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected String	get(String url) Performs a GET request to the specified URL.
protected String	getBaseUrl() Determines the base URL for the API based on the current locale.
Locale	getLocale() Retrieves the language for this Client instance.
List<String>	getRegions(String url) Returns the list of the available regions for a given URL.
protected List<String>	getYears(String url) Returns the list of the available years for a given URL.
protected String	post(String url, String query) Performs a POST request to the specified URL.
void	setLocale(Locale locale) Sets the language for this client instance.
void	setLocalizationLanguage(Locale locale) Changes the language 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

queryBuilder

protected QueryBuilder queryBuilder

localization

protected Localization localization

Constructor Detail

AbstractClient

protected AbstractClient()

AbstractClient

protected AbstractClient(Locale locale)

Overloaded constructor

Parameters:

locale - the locale for this client

Method Detail

getLocale

public Locale getLocale()

Retrieves the language for this Client instance.

Returns:

the language for this Client instance

setLocale

public void setLocale(Locale locale)

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

Parameters:

locale - the language for this client

setLocalizationLanguage

public void setLocalizationLanguage(Locale locale)

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

Parameters:

locale - the language 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 url)

Performs a GET request to the specified URL.

Parameters:

url - the URL which will be sent a GET request

Returns:

a string representation of the API's response

post

protected String post(String url,
          String query)

Performs a POST request to the specified URL.

Parameters:

url - the URL which will be sent a POST request

query - the payload which the API processes

Returns:

a string representation of the API's response

getRegions

public List<String> getRegions(String url)

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

Parameters:

url - the URL to retrieve the regions from

Returns:

a list of the available regions for the given URL

Throws:

UnsupportedOperationException - if the specified URL doesn't supply a regions table

getYears

protected List<String> getYears(String url)

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

Parameters:

url - the URL to retrieve the years from

Returns:

a list of the available years for the given URL

Throws:

UnsupportedOperationException - if the specified URL doesn't supply a years table