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

Class PopulationStatisticsDeathsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.deaths.PopulationStatisticsDeathsClient

public class PopulationStatisticsDeathsClient
extends AbstractClient

Client which handles population statistics deaths data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getInfantMortality() Fetch all infant mortality data.
List<ResponseModel>	getInfantMortality(Collection<String> sexes, Collection<String> infantMortalities, Collection<Integer> years) Fetch all infant mortality data which match the input constraints.
List<ResponseModel>	getLifeExpectency() Fetch all life expectancy data.
List<ResponseModel>	getLifeExpectency(Collection<String> regions, Collection<Integer> sexes, Collection<String> periods) Fetch all life expectancy data which match the input constraints.
List<ResponseModel>	getLifeTable() Fetch all life table data.
List<ResponseModel>	getLifeTable(Collection<Integer> sexes, Collection<Integer> ages, Collection<Integer> years) Fetch all life table data which match the input constraints.
List<ResponseModel>	getMortalityRate() Fetch all mortality rate data.
List<ResponseModel>	getMortalityRate(Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all mortality rate data which match the input constraints.
List<ResponseModel>	getStillborn() Fetch all stillborn data.
List<ResponseModel>	getStillborn(Collection<String> regions, Collection<String> agesOfMothers, Collection<Integer> sexes, Collection<Integer> years) Fetch all stillborn 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

PopulationStatisticsDeathsClient

public PopulationStatisticsDeathsClient()

Default constructor.

PopulationStatisticsDeathsClient

public PopulationStatisticsDeathsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getMortalityRate

public List<ResponseModel> getMortalityRate()

Fetch all mortality rate data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getMortalityRate(Collection, Collection, Collection)

getMortalityRate

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

Fetch all mortality rate data which match the input constraints.

Parameters:

ages - the ages

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getStillborn

public List<ResponseModel> getStillborn()

Fetch all stillborn data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getStillborn(Collection, Collection, Collection, Collection)

getStillborn

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

Fetch all stillborn data which match the input constraints.

Parameters:

regions - the regions

agesOfMothers - the ages of mothers

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLifeExpectency

public List<ResponseModel> getLifeExpectency()

Fetch all life expectancy data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLifeExpectency(Collection, Collection, Collection)

getLifeExpectency

public List<ResponseModel> getLifeExpectency(Collection<String> regions,
                                             Collection<Integer> sexes,
                                             Collection<String> periods)

Fetch all life expectancy data which match the input constraints.

Parameters:

regions - the regions

sexes - the sexes

periods - the periods

Returns:

the data wrapped in a list of ResponseModel objects

getLifeTable

public List<ResponseModel> getLifeTable()

Fetch all life table data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLifeTable(Collection, Collection, Collection)

getLifeTable

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

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

getInfantMortality

public List<ResponseModel> getInfantMortality()

Fetch all infant mortality data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getInfantMortality(Collection, Collection, Collection)

getInfantMortality

public List<ResponseModel> getInfantMortality(Collection<String> sexes,
                                              Collection<String> infantMortalities,
                                              Collection<Integer> years)

Fetch all infant mortality data which match the input constraints.

Parameters:

sexes - the sexes

infantMortalities - the infant mortalities

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