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

Class PopulationStatisticsVitalEventsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.vitalevents.PopulationStatisticsVitalEventsClient

public class PopulationStatisticsVitalEventsClient
extends AbstractClient

Client which handles population statistics vital events data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getBirthsAndDeathsPerMonth() Fetch all births and deaths per month data.
List<ResponseModel>	getBirthsAndDeathsPerMonth(Collection<Integer> sexes, Collection<String> months, Collection<Integer> years) Fetch all births and deaths per month data which match the input constraints.
List<ResponseModel>	getPopulationAndPopulationChanges() Fetch all population and population changes data.
List<ResponseModel>	getPopulationAndPopulationChanges(Collection<String> sexes, Collection<Integer> years) Fetch all population and population changes data which match the input constraints.
List<ResponseModel>	getPopulationChangesNumberOfPersons() Fetch all population changes number of persons data.
List<ResponseModel>	getPopulationChangesNumberOfPersons(Collection<String> regions, Collection<Integer> populationChanges, Collection<Integer> sexes, Collection<Integer> years) Fetch all population changes number of persons 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

PopulationStatisticsVitalEventsClient

public PopulationStatisticsVitalEventsClient()

Default constructor.

PopulationStatisticsVitalEventsClient

public PopulationStatisticsVitalEventsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPopulationChangesNumberOfPersons

public List<ResponseModel> getPopulationChangesNumberOfPersons()

Fetch all population changes number of persons data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationChangesNumberOfPersons(Collection, Collection, Collection, Collection)

getPopulationChangesNumberOfPersons

public List<ResponseModel> getPopulationChangesNumberOfPersons(Collection<String> regions,
                                                               Collection<Integer> populationChanges,
                                                               Collection<Integer> sexes,
                                                               Collection<Integer> years)

Fetch all population changes number of persons data which match the input constraints.

Parameters:

regions - the regions

populationChanges - the population changes

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationAndPopulationChanges

public List<ResponseModel> getPopulationAndPopulationChanges()

Fetch all population and population changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationAndPopulationChanges(Collection, Collection)

getPopulationAndPopulationChanges

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

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

Parameters:

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getBirthsAndDeathsPerMonth

public List<ResponseModel> getBirthsAndDeathsPerMonth()

Fetch all births and deaths per month data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBirthsAndDeathsPerMonth(Collection, Collection, Collection)

getBirthsAndDeathsPerMonth

public List<ResponseModel> getBirthsAndDeathsPerMonth(Collection<Integer> sexes,
                                                      Collection<String> months,
                                                      Collection<Integer> years)

Fetch all births and deaths per month data which match the input constraints.

Parameters:

sexes - the sexes

months - the months

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