com.github.dannil.scbjavaclient.client.environment.islands

Class EnvironmentIslandsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.islands.EnvironmentIslandsClient

public class EnvironmentIslandsClient
extends AbstractClient

Client which handles environment islands data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getBuildingsOnIslands() Fetch all buildings on islands data.
List<ResponseModel>	getBuildingsOnIslands(Collection<String> regions, Collection<Integer> years) Fetch all buildings on islands data which match the input constraints.
List<ResponseModel>	getIslandsInSweden() Fetch all islands in Sweden data.
List<ResponseModel>	getIslandsInSweden(Collection<String> regions, Collection<Integer> years) Fetch all islands in Sweden data which match the input constraints.
List<ResponseModel>	getIslandsInSwedenByNumberAreaAndPerimiter() Fetch all islands in Sweden by number, area and perimeter data.
List<ResponseModel>	getIslandsInSwedenByNumberAreaAndPerimiter(Collection<String> regions, Collection<Integer> years) Fetch all islands in Sweden by number, area and perimeter data which match the input constraints.
List<ResponseModel>	getNumberOfIslandsInSweden() Fetch all number of islands in Sweden data.
List<ResponseModel>	getNumberOfIslandsInSweden(Collection<String> regions, Collection<String> sizeClasses, Collection<Integer> years) Fetch all number of islands in Sweden data which match the input constraints.
List<ResponseModel>	getPopulatedIslands() Fetch all populated islands data.
List<ResponseModel>	getPopulatedIslands(Collection<String> regions, Collection<Integer> years) Fetch all populated islands data which match the input constraints.
List<ResponseModel>	getPopulationOnIslands() Fetch all population on islands data.
List<ResponseModel>	getPopulationOnIslands(Collection<String> regions, Collection<Integer> years) Fetch all population on islands data which match the input constraints.
List<ResponseModel>	getShorelinePopulation() Fetch all shoreline population data.
List<ResponseModel>	getShorelinePopulation(Collection<String> regions, Collection<String> livings, Collection<Integer> years) Fetch all shoreline population 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

EnvironmentIslandsClient

public EnvironmentIslandsClient()

Default constructor.

EnvironmentIslandsClient

public EnvironmentIslandsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getShorelinePopulation

public List<ResponseModel> getShorelinePopulation()

Fetch all shoreline population data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getShorelinePopulation(Collection, Collection, Collection)

getShorelinePopulation

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

Fetch all shoreline population data which match the input constraints.

Parameters:

regions - the regions

livings - the livings

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulatedIslands

public List<ResponseModel> getPopulatedIslands()

Fetch all populated islands data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulatedIslands(Collection, Collection)

getPopulatedIslands

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

Fetch all populated islands data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getIslandsInSweden

public List<ResponseModel> getIslandsInSweden()

Fetch all islands in Sweden data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getIslandsInSweden(Collection, Collection)

getIslandsInSweden

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

Fetch all islands in Sweden data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getBuildingsOnIslands

public List<ResponseModel> getBuildingsOnIslands()

Fetch all buildings on islands data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBuildingsOnIslands(Collection, Collection)

getBuildingsOnIslands

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

Fetch all buildings on islands data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getIslandsInSwedenByNumberAreaAndPerimiter

public List<ResponseModel> getIslandsInSwedenByNumberAreaAndPerimiter()

Fetch all islands in Sweden by number, area and perimeter data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getIslandsInSwedenByNumberAreaAndPerimiter(Collection, Collection)

getIslandsInSwedenByNumberAreaAndPerimiter

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

Fetch all islands in Sweden by number, area and perimeter data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationOnIslands

public List<ResponseModel> getPopulationOnIslands()

Fetch all population on islands data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationOnIslands(Collection, Collection)

getPopulationOnIslands

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

Fetch all population on islands data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNumberOfIslandsInSweden

public List<ResponseModel> getNumberOfIslandsInSweden()

Fetch all number of islands in Sweden data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNumberOfIslandsInSweden(Collection, Collection, Collection)

getNumberOfIslandsInSweden

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

Fetch all number of islands in Sweden data which match the input constraints.

Parameters:

regions - the regions

sizeClasses - the size classes

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