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

Class PopulationStatisticsMigrationClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.migration.PopulationStatisticsMigrationClient

public class PopulationStatisticsMigrationClient
extends AbstractClient

Client which handles population statistics migration data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getImmigrations()	Fetch all immigrations data.
List<ResponseModel>	getImmigrations(Collection<String> groundsForSettlements, Collection<String> countriesOfBirths, Collection<Integer> sexes, Collection<Integer> years)	Fetch all immigrations data which match the input constraints.
List<ResponseModel>	getMigration()	Fetch all migration data.
List<ResponseModel>	getMigration(Collection<String> regions, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years)	Fetch all migration 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

PopulationStatisticsMigrationClient

public PopulationStatisticsMigrationClient()

Default constructor.

PopulationStatisticsMigrationClient

public PopulationStatisticsMigrationClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getImmigrations

public List<ResponseModel> getImmigrations()

Fetch all immigrations data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getImmigrations(Collection, Collection, Collection, Collection)

getImmigrations

public List<ResponseModel> getImmigrations(Collection<String> groundsForSettlements,
                                           Collection<String> countriesOfBirths,
                                           Collection<Integer> sexes,
                                           Collection<Integer> years)

Fetch all immigrations data which match the input constraints.

Parameters:

groundsForSettlements - the grounds for settlements

countriesOfBirths - the countries of births

sexes - the sexes

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getMigration

public List<ResponseModel> getMigration()

Fetch all migration data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getMigration(Collection, Collection, Collection, Collection)

getMigration

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

Fetch all migration data which match the input constraints.

Parameters:

regions - the regions

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