com.github.dannil.scbjavaclient.client.population.partnership

Class PopulationPartnershipClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.partnership.PopulationPartnershipClient

public class PopulationPartnershipClient
extends AbstractClient

Client which handles population partnership data fetching.

Since:

0.1.0

Field Summary

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

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Partnership>	getPartnership() Fetch all population partnership data.
List<Partnership>	getPartnership(Collection<String> regions, Collection<String> maritalStatuses, Collection<Integer> sexes, Collection<Integer> years) Fetch all population partnership data which match the input constraints.
List<PartnershipChange>	getPartnershipChange() Fetch all population partnership change data.
List<PartnershipChange>	getPartnershipChange(Collection<String> regions, Collection<String> maritalStatuses, Collection<Integer> sexes, Collection<Integer> years) Fetch all population partnership change 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

PopulationPartnershipClient

public PopulationPartnershipClient()

Default constructor.

PopulationPartnershipClient

public PopulationPartnershipClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPartnership

public List<Partnership> getPartnership()

Fetch all population partnership data.

Returns:

the population partnership data wrapped in a list of Partnership objects

See Also:

getPartnership(Collection, Collection, Collection, Collection)

getPartnership

public List<Partnership> getPartnership(Collection<String> regions,
                                        Collection<String> maritalStatuses,
                                        Collection<Integer> sexes,
                                        Collection<Integer> years)

Fetch all population partnership data which match the input constraints.

Parameters:

regions - the regions to fetch data for

maritalStatuses - the marital statuses to fetch data for

sexes - the sexes to fetch data for

years - the years to fetch data for

Returns:

the population partnership data wrapped in a list of Partnership objects

getPartnershipChange

public List<PartnershipChange> getPartnershipChange()

Fetch all population partnership change data.

Returns:

the population partnership change data wrapped in a list of PartnershipChange objects

See Also:

getPartnershipChange(Collection, Collection, Collection, Collection)

getPartnershipChange

public List<PartnershipChange> getPartnershipChange(Collection<String> regions,
                                                    Collection<String> maritalStatuses,
                                                    Collection<Integer> sexes,
                                                    Collection<Integer> years)

Fetch all population partnership change data which match the input constraints.

Parameters:

regions - the regions to fetch data for

maritalStatuses - the marital statuses to fetch data for

sexes - the sexes to fetch data for

years - the years to fetch data for

Returns:

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