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

Class PopulationStatisticsLiveBirthsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.livebirths.PopulationStatisticsLiveBirthsClient

public class PopulationStatisticsLiveBirthsClient
extends AbstractClient

Client which handles population statistics live births data fetching.

Since:

0.1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getLiveBirths() Fetch all live births data.
List<ResponseModel>	getLiveBirths(Collection<String> regions, Collection<String> agesOfMothers, Collection<Integer> sexes, Collection<Integer> years) Fetch all live births 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

PopulationStatisticsLiveBirthsClient

public PopulationStatisticsLiveBirthsClient()

Default constructor.

PopulationStatisticsLiveBirthsClient

public PopulationStatisticsLiveBirthsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLiveBirths

public List<ResponseModel> getLiveBirths()

Fetch all live births data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLiveBirths(Collection, Collection, Collection, Collection)

getLiveBirths

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

Fetch all live births data which match the input constraints.

Parameters:

regions - the regions to fetch data for

agesOfMothers - the ages of mothers 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