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

Class PopulationStatisticsMeanPopulationClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.meanpopulation.PopulationStatisticsMeanPopulationClient

public class PopulationStatisticsMeanPopulationClient
extends AbstractClient

Client which handles population statistics mean population data fetching.

Since:

1.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getMeanPopulationByBirthYear() Fetch all mean population by birth year data.
List<ResponseModel>	getMeanPopulationByBirthYear(Collection<String> regions, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all mean population by birth year data which match the input constraints.
List<ResponseModel>	getMeanPopulationByCurrentAge() Fetch all mean population by current age data.
List<ResponseModel>	getMeanPopulationByCurrentAge(Collection<String> regions, Collection<String> maritalStatuses, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all mean population by current age 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

PopulationStatisticsMeanPopulationClient

public PopulationStatisticsMeanPopulationClient()

Default constructor.

PopulationStatisticsMeanPopulationClient

public PopulationStatisticsMeanPopulationClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getMeanPopulationByBirthYear

public List<ResponseModel> getMeanPopulationByBirthYear()

Fetch all mean population by birth year data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getMeanPopulationByBirthYear(Collection, Collection, Collection, Collection)

getMeanPopulationByBirthYear

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

Fetch all mean population by birth year data which match the input constraints.

Parameters:

regions - the regions to fetch data for

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

getMeanPopulationByCurrentAge

public List<ResponseModel> getMeanPopulationByCurrentAge()

Fetch all mean population by current age data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getMeanPopulationByCurrentAge(Collection, Collection, Collection, Collection, Collection)

getMeanPopulationByCurrentAge

public List<ResponseModel> getMeanPopulationByCurrentAge(Collection<String> regions,
                                                         Collection<String> maritalStatuses,
                                                         Collection<String> ages,
                                                         Collection<Integer> sexes,
                                                         Collection<Integer> years)

Fetch all mean population by current age data which match the input constraints.

Parameters:

regions - the regions to fetch data for

maritalStatuses - the marital statuses to fetch data for

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