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

Class PopulationLiveBirthsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

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

public class PopulationLiveBirthsClient
extends AbstractClient

Client which handles population live births data fetching.

Since:

0.1.0

Field Summary

Fields inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<LiveBirth>	getLiveBirths() Fetch all live births data.
List<LiveBirth>	getLiveBirths(Collection<String> regions, Collection<String> motherAges, Collection<Integer> genders, Collection<Integer> years) Fetch all live births data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

get, getBaseUrl, getLocale, getRegions, getYears, post, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PopulationLiveBirthsClient

public PopulationLiveBirthsClient()

Default constructor.

PopulationLiveBirthsClient

public PopulationLiveBirthsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLiveBirths

public List<LiveBirth> getLiveBirths()

Fetch all live births data.

Returns:

the live births data wrapped in a list of LiveBirth objects

See Also:

getLiveBirths(Collection, Collection, Collection, Collection)

getLiveBirths

public List<LiveBirth> getLiveBirths(Collection<String> regions,
                                     Collection<String> motherAges,
                                     Collection<Integer> genders,
                                     Collection<Integer> years)

Fetch all live births data which match the input constraints.

Parameters:

regions - the regions to fetch data for

motherAges - the mothers' ages to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the live births data wrapped in a list of LiveBirth objects

getUrl

public String getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Overrides:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client