Package com.github.dannil.scbjavaclient.client.environment.landuse.usage

Class EnvironmentLandUseUsageClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.landuse.usage.EnvironmentLandUseUsageClient

public class EnvironmentLandUseUsageClient
extends AbstractClient

Client which handles environment land use usage data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getArableAndForestLand()	Fetch all arable land and forest land data.
List<ResponseModel>	getArableAndForestLand(Collection<String> regions, Collection<Integer> categories, Collection<Integer> years)	Fetch all arable land and forest land data which match the input constraints.
List<ResponseModel>	getBuiltUpLand()	Fetch all built up land data.
List<ResponseModel>	getBuiltUpLand(Collection<String> regions, Collection<Integer> categories, Collection<Integer> years)	Fetch all built up land data which match the input constraints.
List<ResponseModel>	getLandUseByCounty()	Fetch all land use by county data.
List<ResponseModel>	getLandUseByCounty(Collection<String> regions, Collection<Integer> categories, Collection<Integer> years)	Fetch all land use by county data which match the input constraints.
List<ResponseModel>	getLandUseByMunicipality()	Fetch all land use by municipality data.
List<ResponseModel>	getLandUseByMunicipality(Collection<String> regions, Collection<Integer> categories, Collection<Integer> years)	Fetch all land use by municipality data which match the input constraints.
List<ResponseModel>	getTransportInfrastructureArea()	Deprecated, for removal: This API element is subject to removal in a future version. use EnvironmentLandUseInfrastructureForTransportClient#getLandWithTransportInfrastructure() instead.
List<ResponseModel>	getTransportInfrastructureArea(Collection<String> regions, Collection<Integer> years)	Deprecated, for removal: This API element is subject to removal in a future version. use EnvironmentLandUseInfrastructureForTransportClient#getLandWithTransportInfrastructure(Collection, Collection) instead.
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

EnvironmentLandUseUsageClient

public EnvironmentLandUseUsageClient()

Default constructor.

EnvironmentLandUseUsageClient

public EnvironmentLandUseUsageClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getArableAndForestLand

public List<ResponseModel> getArableAndForestLand()

Fetch all arable land and forest land data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getArableAndForestLand(Collection, Collection, Collection)

getArableAndForestLand

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

Fetch all arable land and forest land data which match the input constraints.

Parameters:

regions - the regions to fetch data for

categories - the categories to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getBuiltUpLand

public List<ResponseModel> getBuiltUpLand()

Fetch all built up land data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getBuiltUpLand(Collection, Collection, Collection)

getBuiltUpLand

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

Fetch all built up land data which match the input constraints.

Parameters:

regions - the regions to fetch data for

categories - the categories to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getLandUseByCounty

public List<ResponseModel> getLandUseByCounty()

Fetch all land use by county data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLandUseByCounty(Collection, Collection, Collection)

getLandUseByCounty

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

Fetch all land use by county data which match the input constraints.

Parameters:

regions - the regions to fetch data for

categories - the categories to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getLandUseByMunicipality

public List<ResponseModel> getLandUseByMunicipality()

Fetch all land use by municipality data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLandUseByMunicipality(Collection, Collection, Collection)

getLandUseByMunicipality

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

Fetch all land use by municipality data which match the input constraints.

Parameters:

regions - the regions to fetch data for

categories - the categories to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getTransportInfrastructureArea

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getTransportInfrastructureArea()

Deprecated, for removal: This API element is subject to removal in a future version.

use EnvironmentLandUseInfrastructureForTransportClient#getLandWithTransportInfrastructure() instead.

Fetch all transport infrastructure area data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getTransportInfrastructureArea(Collection, Collection)

getTransportInfrastructureArea

@Deprecated(since="3.0.0",
            forRemoval=true)
public List<ResponseModel> getTransportInfrastructureArea(Collection<String> regions,
                                                          Collection<Integer> years)

Deprecated, for removal: This API element is subject to removal in a future version.

use EnvironmentLandUseInfrastructureForTransportClient#getLandWithTransportInfrastructure(Collection, Collection) instead.

Fetch all transport infrastructure area data which match the input constraints.

Parameters:

regions - the regions

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