com.github.dannil.scbjavaclient.client.population.statistics.density

Class PopulationStatisticsDensityClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.density.PopulationStatisticsDensityClient

public class PopulationStatisticsDensityClient
extends AbstractClient

Client which handles population statistics density data fetching.

Since:

0.1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getDensity() Fetch all density data.
List<ResponseModel>	getDensity(Collection<String> regions, Collection<String> sexes, Collection<Integer> years) Fetch all density data which match the input constraints.
URLEndpoint	getUrl() Returns the URL endpoint which this client represents.

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

doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

PopulationStatisticsDensityClient

public PopulationStatisticsDensityClient()

Default constructor.

PopulationStatisticsDensityClient

public PopulationStatisticsDensityClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getDensity

public List<ResponseModel> getDensity()

Fetch all density data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getDensity(Collection, Collection, Collection)

getDensity

public List<ResponseModel> getDensity(Collection<String> regions,
                                      Collection<String> sexes,
                                      Collection<Integer> years)

Fetch all density data which match the input constraints.

Parameters:

regions - the regions to fetch data for

sexes - the sexes to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getUrl

public URLEndpoint getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Specified by:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client