com.github.dannil.scbjavaclient.client.population.statistic

Class PopulationStatisticsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistic.PopulationStatisticsClient

public class PopulationStatisticsClient
extends AbstractClient

Client which handles population statistics data fetching.

Author:

Daniel Nilsson

Field Summary

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

locale, localization, ROOT_URL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<AverageAge>	getAverageAge() Fetch all average age data.
List<AverageAge>	getAverageAge(Collection<String> regions, Collection<String> genders, Collection<Integer> years) Fetch all average age data which match the input constraints.
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.
List<Population>	getPopulation() Fetch all population data data.
List<Population>	getPopulation(Collection<String> regions, Collection<String> relationshipStatuses, Collection<String> ages, Collection<Integer> genders, Collection<Integer> years) Fetch all population 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, setLocalizationLanguage

Methods inherited from class java.lang.Object

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

Constructor Detail

PopulationStatisticsClient

public PopulationStatisticsClient()

Default constructor.

PopulationStatisticsClient

public PopulationStatisticsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the locale for this client

Method Detail

getAverageAge

public List<AverageAge> getAverageAge()

Fetch all average age data.

Returns:

the average age data wrapped in a list of AverageAge objects

See Also:

getAverageAge(Collection, Collection, Collection)

getAverageAge

public List<AverageAge> getAverageAge(Collection<String> regions,
                                      Collection<String> genders,
                                      Collection<Integer> years)

Fetch all average age 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 average age data wrapped in a list of AverageAge objects

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

getPopulation

public List<Population> getPopulation()

Fetch all population data data.

Returns:

the population data wrapped in a list of Population objects

See Also:

getPopulation(Collection, Collection, Collection, Collection, Collection)

getPopulation

public List<Population> getPopulation(Collection<String> regions,
                                      Collection<String> relationshipStatuses,
                                      Collection<String> ages,
                                      Collection<Integer> genders,
                                      Collection<Integer> years)

Fetch all population data which match the input constraints.

Parameters:

regions - the regions to fetch data for

relationshipStatuses - the relationship statuses to fetch data for

ages - the ages to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the population data wrapped in a list of Population 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