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

Class PopulationStatisticsBackgroundClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.background.PopulationStatisticsBackgroundClient

public class PopulationStatisticsBackgroundClient
extends AbstractClient

Client which handles population statistics background data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getPersonsWithBackgroundDetailedDivision() Fetch all number of persons with foreign or Swedish background (detailed division) data.
List<ResponseModel>	getPersonsWithBackgroundDetailedDivision(Collection<String> regions, Collection<String> backgrounds, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all number of persons with foreign or Swedish background (detailed division) data which match the input constraints.
List<ResponseModel>	getPersonsWithBackgroundRoughDivision() Fetch all number of persons with foreign or Swedish background (rough division) data.
List<ResponseModel>	getPersonsWithBackgroundRoughDivision(Collection<String> regions, Collection<Integer> backgrounds, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all number of persons with foreign or Swedish background (rough division) 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

PopulationStatisticsBackgroundClient

public PopulationStatisticsBackgroundClient()

Default constructor.

PopulationStatisticsBackgroundClient

public PopulationStatisticsBackgroundClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPersonsWithBackgroundRoughDivision

public List<ResponseModel> getPersonsWithBackgroundRoughDivision()

Fetch all number of persons with foreign or Swedish background (rough division) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPersonsWithBackgroundRoughDivision(Collection, Collection, Collection, Collection, Collection)

getPersonsWithBackgroundRoughDivision

public List<ResponseModel> getPersonsWithBackgroundRoughDivision(Collection<String> regions,
                                                                 Collection<Integer> backgrounds,
                                                                 Collection<String> ages,
                                                                 Collection<Integer> sexes,
                                                                 Collection<Integer> years)

Fetch all number of persons with foreign or Swedish background (rough division) data which match the input constraints.

Parameters:

regions - the regions

backgrounds - the backgrounds

ages - the ages

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPersonsWithBackgroundDetailedDivision

public List<ResponseModel> getPersonsWithBackgroundDetailedDivision()

Fetch all number of persons with foreign or Swedish background (detailed division) data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPersonsWithBackgroundDetailedDivision(Collection, Collection, Collection, Collection, Collection)

getPersonsWithBackgroundDetailedDivision

public List<ResponseModel> getPersonsWithBackgroundDetailedDivision(Collection<String> regions,
                                                                    Collection<String> backgrounds,
                                                                    Collection<String> ages,
                                                                    Collection<Integer> sexes,
                                                                    Collection<Integer> years)

Fetch all number of persons with foreign or Swedish background (detailed division) data which match the input constraints.

Parameters:

regions - the regions

backgrounds - the backgrounds

ages - the ages

sexes - the sexes

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