com.github.dannil.scbjavaclient.client.population.demography

Class PopulationDemographyClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.demography.PopulationDemographyClient

public class PopulationDemographyClient
extends AbstractClient

Client which handles population demography data fetching.

Since:

0.0.2

Field Summary

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

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<FertilityRate>	getFertilityRate() Fetch all fertility rate data.
List<FertilityRate>	getFertilityRate(Collection<String> regions, Collection<Integer> genders, Collection<Integer> years) Fetch all fertility rate data which match the input constraints.
List<MeanAgeFirstChild>	getMeanAgeFirstChild() Fetch all mean age for the first child data.
List<MeanAgeFirstChild>	getMeanAgeFirstChild(Collection<String> regions, Collection<Integer> genders, Collection<Integer> years) Fetch all mean age for the first child 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

PopulationDemographyClient

public PopulationDemographyClient()

Default constructor.

PopulationDemographyClient

public PopulationDemographyClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getFertilityRate

public List<FertilityRate> getFertilityRate()

Fetch all fertility rate data.

Returns:

the fertility rate data wrapped in a list of FertilityRate objects

See Also:

getFertilityRate(Collection, Collection, Collection)

getFertilityRate

public List<FertilityRate> getFertilityRate(Collection<String> regions,
                                            Collection<Integer> genders,
                                            Collection<Integer> years)

Fetch all fertility rate data which match the input constraints.

Parameters:

regions - the regions to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the fertility rate data wrapped in a list of FertilityRate objects

getMeanAgeFirstChild

public List<MeanAgeFirstChild> getMeanAgeFirstChild()

Fetch all mean age for the first child data.

Returns:

the mean age for the first child data wrapped in a list of MeanAgeFirstChild objects

See Also:

getMeanAgeFirstChild(Collection, Collection, Collection)

getMeanAgeFirstChild

public List<MeanAgeFirstChild> getMeanAgeFirstChild(Collection<String> regions,
                                                    Collection<Integer> genders,
                                                    Collection<Integer> years)

Fetch all mean age for the first child data which match the input constraints.

Parameters:

regions - the regions to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the mean age for the first child data wrapped in a list of MeanAgeFirstChild 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