com.github.dannil.scbjavaclient.client.environment.localitiesareasandpopulation.population

Class EnvironmentLocalitiesAreasAndPopulationPopulationClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.localitiesareasandpopulation.population.EnvironmentLocalitiesAreasAndPopulationPopulationClient

public class EnvironmentLocalitiesAreasAndPopulationPopulationClient
extends AbstractClient

Client which handles environment localities areas and population population data fetching.

Since:

0.7.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getNumberOfLocalitiesAndPopulationDensity() Fetch all number of localities and population density data.
List<ResponseModel>	getNumberOfLocalitiesAndPopulationDensity(Collection<String> regions, Collection<Integer> years) Fetch all number of localities and population density data which match the input constraints.
List<ResponseModel>	getPopulationAndLandAreaWithinAndOutsideOfLocalities() Fetch all population and land area within and outside of localities data.
List<ResponseModel>	getPopulationAndLandAreaWithinAndOutsideOfLocalities(Collection<String> regions, Collection<String> typesOfAreas, Collection<Integer> years) Fetch all population and land area within and outside of localities data which match the input constraints.
List<ResponseModel>	getPopulationAndLandAreaWithinLocalities() Fetch all population and land area within localities data.
List<ResponseModel>	getPopulationAndLandAreaWithinLocalities(Collection<String> regions, Collection<Integer> years) Fetch all population and land area within localities 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

EnvironmentLocalitiesAreasAndPopulationPopulationClient

public EnvironmentLocalitiesAreasAndPopulationPopulationClient()

Default constructor.

EnvironmentLocalitiesAreasAndPopulationPopulationClient

public EnvironmentLocalitiesAreasAndPopulationPopulationClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPopulationAndLandAreaWithinLocalities

public List<ResponseModel> getPopulationAndLandAreaWithinLocalities()

Fetch all population and land area within localities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationAndLandAreaWithinLocalities(Collection, Collection)

getPopulationAndLandAreaWithinLocalities

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

Fetch all population and land area within localities data which match the input constraints.

Parameters:

regions - the regions to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationAndLandAreaWithinAndOutsideOfLocalities

public List<ResponseModel> getPopulationAndLandAreaWithinAndOutsideOfLocalities()

Fetch all population and land area within and outside of localities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationAndLandAreaWithinAndOutsideOfLocalities(Collection, Collection, Collection)

getPopulationAndLandAreaWithinAndOutsideOfLocalities

public List<ResponseModel> getPopulationAndLandAreaWithinAndOutsideOfLocalities(Collection<String> regions,
                                                                                Collection<String> typesOfAreas,
                                                                                Collection<Integer> years)

Fetch all population and land area within and outside of localities data which match the input constraints.

Parameters:

regions - the regions to fetch data for

typesOfAreas - the types of areas to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfLocalitiesAndPopulationDensity

public List<ResponseModel> getNumberOfLocalitiesAndPopulationDensity()

Fetch all number of localities and population density data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfLocalitiesAndPopulationDensity(Collection, Collection)

getNumberOfLocalitiesAndPopulationDensity

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

Fetch all number of localities and population density data which match the input constraints.

Parameters:

regions - the regions to fetch data for

years - the years to fetch data for

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