Package com.github.dannil.scbjavaclient.client.population.projections.latestassumptions

Class PopulationProjectionsLatestAssumptionsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.projections.latestassumptions.PopulationProjectionsLatestAssumptionsClient

public class PopulationProjectionsLatestAssumptionsClient
extends AbstractClient

Client which handles population projections latest assumptions data fetching.

Since:

0.3.0

Constructor Summary

Constructors

Constructor	Description
PopulationProjectionsLatestAssumptionsClient()	Default constructor.
PopulationProjectionsLatestAssumptionsClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getDeathRate()	Fetch all death rate data.
List<ResponseModel>	getDeathRate(Collection<Integer> sexes, Collection<String> ages, Collection<Integer> years)	Fetch all death rate data which match the input constraints.
List<ResponseModel>	getEmigrationRateAssumption()	Fetch all emigration rate assumption data.
List<ResponseModel>	getEmigrationRateAssumption(Collection<String> regionsOfBirths, Collection<Integer> sexes, Collection<String> ages, Collection<Integer> years)	Fetch all emigration rate assumption data which match the input constraints.
List<ResponseModel>	getFertilityAssumption()	Fetch all fertility assumption data.
List<ResponseModel>	getFertilityAssumption(Collection<String> mothersRegionsOfBirths, Collection<String> ages, Collection<Integer> years)	Fetch all fertility assumption 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

PopulationProjectionsLatestAssumptionsClient

public PopulationProjectionsLatestAssumptionsClient()

Default constructor.

PopulationProjectionsLatestAssumptionsClient

public PopulationProjectionsLatestAssumptionsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getDeathRate

public List<ResponseModel> getDeathRate()

Fetch all death rate data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getDeathRate(Collection, Collection, Collection)

getDeathRate

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

Fetch all death rate data which match the input constraints.

Parameters:

sexes - the sexes

ages - the ages

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getEmigrationRateAssumption

public List<ResponseModel> getEmigrationRateAssumption()

Fetch all emigration rate assumption data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getEmigrationRateAssumption(Collection, Collection, Collection, Collection)

getEmigrationRateAssumption

public List<ResponseModel> getEmigrationRateAssumption(Collection<String> regionsOfBirths,
                                                       Collection<Integer> sexes,
                                                       Collection<String> ages,
                                                       Collection<Integer> years)

Fetch all emigration rate assumption data which match the input constraints.

Parameters:

regionsOfBirths - the regions of births

sexes - the sexes

ages - the ages

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getFertilityAssumption

public List<ResponseModel> getFertilityAssumption()

Fetch all fertility assumption data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getFertilityAssumption(Collection, Collection, Collection)

getFertilityAssumption

public List<ResponseModel> getFertilityAssumption(Collection<String> mothersRegionsOfBirths,
                                                  Collection<String> ages,
                                                  Collection<Integer> years)

Fetch all fertility assumption data which match the input constraints.

Parameters:

mothersRegionsOfBirths - the mother's regions of birth

ages - the ages

years - the years

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