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

Class PopulationProjectionsLatestProjectionsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.projections.latestprojections.PopulationProjectionsLatestProjectionsClient

public class PopulationProjectionsLatestProjectionsClient
extends AbstractClient

Client which handles population projections latest projections data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getLifeExpectancy()	Fetch all life expectancy data.
List<ResponseModel>	getLifeExpectancy(Collection<Integer> sexes, Collection<String> ages, Collection<Integer> years)	Fetch all life expectancy data which match the input constraints.
List<ResponseModel>	getNumberOfBirths()	Fetch all number of births data.
List<ResponseModel>	getNumberOfBirths(Collection<String> mothersRegionsOfBirths, Collection<String> ages, Collection<Integer> years)	Fetch all number of births data which match the input constraints.
List<ResponseModel>	getPopulation()	Fetch all population data.
List<ResponseModel>	getPopulation(Collection<Integer> regionsOfBirths, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years)	Fetch all population data which match the input constraints.
List<ResponseModel>	getPopulationChanges()	Fetch all population changes data.
List<ResponseModel>	getPopulationChanges(Collection<String> regionsOfBirths, Collection<Integer> sexes, Collection<String> ages, Collection<Integer> years)	Fetch all population changes data which match the input constraints.
List<ResponseModel>	getPopulationChangesOverview()	Fetch all population changes overview data.
List<ResponseModel>	getPopulationChangesOverview(Collection<Integer> years)	Fetch all population changes overview 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

PopulationProjectionsLatestProjectionsClient

public PopulationProjectionsLatestProjectionsClient()

Default constructor.

PopulationProjectionsLatestProjectionsClient

public PopulationProjectionsLatestProjectionsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPopulation

public List<ResponseModel> getPopulation()

Fetch all population data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulation(Collection, Collection, Collection, Collection)

getPopulation

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

Fetch all population data which match the input constraints.

Parameters:

regionsOfBirths - the regions of births

ages - the ages

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationChanges

public List<ResponseModel> getPopulationChanges()

Fetch all population changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationChanges(Collection, Collection, Collection, Collection)

getPopulationChanges

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

Fetch all population changes 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

getPopulationChangesOverview

public List<ResponseModel> getPopulationChangesOverview()

Fetch all population changes overview data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationChangesOverview(Collection)

getPopulationChangesOverview

public List<ResponseModel> getPopulationChangesOverview(Collection<Integer> years)

Fetch all population changes overview data which match the input constraints.

Parameters:

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfBirths

public List<ResponseModel> getNumberOfBirths()

Fetch all number of births data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfBirths(Collection, Collection, Collection)

getNumberOfBirths

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

Fetch all number of births data which match the input constraints.

Parameters:

mothersRegionsOfBirths - the mother's regions of births

ages - the ages

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLifeExpectancy

public List<ResponseModel> getLifeExpectancy()

Fetch all life expectancy data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLifeExpectancy(Collection, Collection, Collection)

getLifeExpectancy

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

Fetch all life expectancy 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

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