Package com.github.dannil.scbjavaclient.client.population.statistics.household

Class PopulationStatisticsHouseholdClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.household.PopulationStatisticsHouseholdClient

public class PopulationStatisticsHouseholdClient
extends AbstractClient

Client which handles population statistics household data fetching.

Since:

0.4.0

Constructor Summary

Constructors

Constructor	Description
PopulationStatisticsHouseholdClient()	Default constructor.
PopulationStatisticsHouseholdClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getNumberOfAndPercentageOfPersonsAndHouseholds()	Fetch all number and percentage of persons and households data.
List<ResponseModel>	getNumberOfAndPercentageOfPersonsAndHouseholds(Collection<String> regions, Collection<String> householdSizes, Collection<Integer> years)	Fetch all number and percentage of persons and households data which match the input constraints.
List<ResponseModel>	getNumberOfHouseholdsAndPersons()	Fetch all number of households and persons data.
List<ResponseModel>	getNumberOfHouseholdsAndPersons(Collection<String> regions, Collection<String> typesOfHouseholds, Collection<String> numberOfChildren, Collection<Integer> years)	Fetch all number of households and persons data which match the input constraints.
List<ResponseModel>	getNumberOfPersons()	Fetch all number of persons data.
List<ResponseModel>	getNumberOfPersons(Collection<String> typesOfHouseholds, Collection<String> householdStatuses, Collection<Integer> sexes, Collection<String> ages, Collection<Integer> years)	Fetch all 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

PopulationStatisticsHouseholdClient

public PopulationStatisticsHouseholdClient()

Default constructor.

PopulationStatisticsHouseholdClient

public PopulationStatisticsHouseholdClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getNumberOfHouseholdsAndPersons

public List<ResponseModel> getNumberOfHouseholdsAndPersons()

Fetch all number of households and persons data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfHouseholdsAndPersons(Collection, Collection, Collection, Collection)

getNumberOfHouseholdsAndPersons

public List<ResponseModel> getNumberOfHouseholdsAndPersons(Collection<String> regions,
                                                           Collection<String> typesOfHouseholds,
                                                           Collection<String> numberOfChildren,
                                                           Collection<Integer> years)

Fetch all number of households and persons data which match the input constraints.

Parameters:

regions - the regions

typesOfHouseholds - the types of households

numberOfChildren - the number of children

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfPersons

public List<ResponseModel> getNumberOfPersons()

Fetch all number of persons data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfPersons(Collection, Collection, Collection, Collection, Collection)

getNumberOfPersons

public List<ResponseModel> getNumberOfPersons(Collection<String> typesOfHouseholds,
                                              Collection<String> householdStatuses,
                                              Collection<Integer> sexes,
                                              Collection<String> ages,
                                              Collection<Integer> years)

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

Parameters:

typesOfHouseholds - the types of households

householdStatuses - the household statuses

sexes - the sexes

ages - the ages

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfAndPercentageOfPersonsAndHouseholds

public List<ResponseModel> getNumberOfAndPercentageOfPersonsAndHouseholds()

Fetch all number and percentage of persons and households data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfAndPercentageOfPersonsAndHouseholds(Collection, Collection, Collection)

getNumberOfAndPercentageOfPersonsAndHouseholds

public List<ResponseModel> getNumberOfAndPercentageOfPersonsAndHouseholds(Collection<String> regions,
                                                                          Collection<String> householdSizes,
                                                                          Collection<Integer> years)

Fetch all number and percentage of persons and households data which match the input constraints.

Parameters:

regions - the regions

householdSizes - the household sizes

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