com.github.dannil.scbjavaclient.client.population.name

Class PopulationNameStatisticsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.name.PopulationNameStatisticsClient

public class PopulationNameStatisticsClient
extends AbstractClient

Client which handles population name statistics data fetching.

Since:

0.0.2

Field Summary

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

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<NumberOfChildrenBornWithFirstName>	getNumberOfChildrenBornWithFirstName() Fetch all number of children born with first name data.
List<NumberOfChildrenBornWithFirstName>	getNumberOfChildrenBornWithFirstName(Collection<String> firstnames, Collection<Integer> years) Fetch number of children born with first name 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

PopulationNameStatisticsClient

public PopulationNameStatisticsClient()

Default constructor.

PopulationNameStatisticsClient

public PopulationNameStatisticsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getNumberOfChildrenBornWithFirstName

public List<NumberOfChildrenBornWithFirstName> getNumberOfChildrenBornWithFirstName()

Fetch all number of children born with first name data.

Returns:

the number of children born with first name data wrapped in a list of NumberOfChildrenBornWithFirstName objects

See Also:

getNumberOfChildrenBornWithFirstName(Collection, Collection)

getNumberOfChildrenBornWithFirstName

public List<NumberOfChildrenBornWithFirstName> getNumberOfChildrenBornWithFirstName(Collection<String> firstnames,
                                                                                    Collection<Integer> years)

Fetch number of children born with first name data which match the input constraints.

Parameters:

firstnames - the firstnames to fetch data for

years - the years to fetch data for

Returns:

the number of children born with first name data wrapped in a list of NumberOfChildrenBornWithFirstName 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