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

Class PopulationStatisticsAmountClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.amount.PopulationStatisticsAmountClient

public class PopulationStatisticsAmountClient
extends AbstractClient

Client which handles population statistics amount data fetching.

Since:

0.1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getPopulation() Fetch all population amount data.
List<ResponseModel>	getPopulation(Collection<String> regions, Collection<String> relationshipStatuses, Collection<String> ages, Collection<Integer> genders, Collection<Integer> years) Fetch all population amount 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

PopulationStatisticsAmountClient

public PopulationStatisticsAmountClient()

Default constructor.

PopulationStatisticsAmountClient

public PopulationStatisticsAmountClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPopulation

public List<ResponseModel> getPopulation()

Fetch all population amount data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulation(Collection, Collection, Collection, Collection, Collection)

getPopulation

public List<ResponseModel> getPopulation(Collection<String> regions,
                                         Collection<String> relationshipStatuses,
                                         Collection<String> ages,
                                         Collection<Integer> genders,
                                         Collection<Integer> years)

Fetch all population amount data which match the input constraints.

Parameters:

regions - the regions to fetch data for

relationshipStatuses - the relationship statuses to fetch data for

ages - the ages to fetch data for

genders - the genders 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