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

Class EnvironmentLandUseInfrastructureForTransportClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.landuse.infrastructurefortransport.EnvironmentLandUseInfrastructureForTransportClient

public class EnvironmentLandUseInfrastructureForTransportClient
extends AbstractClient

Client which handles environment land use infrastructure for transport data fetching.

Since:

2.1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getLandWithTransportInfrastructure()	Fetch all land with transport infrastructure data.
List<ResponseModel>	getLandWithTransportInfrastructure(Collection<String> regions, Collection<Integer> years)	Fetch all land with transport infrastructure data which match the input constraints.
List<ResponseModel>	getRailways()	Fetch all railways data.
List<ResponseModel>	getRailways(Collection<String> regions, Collection<Integer> years)	Fetch all railways data which match the input constraints.
List<ResponseModel>	getRoadArea()	Fetch all road area data.
List<ResponseModel>	getRoadArea(Collection<String> regions, Collection<String> areas, Collection<Integer> years)	Fetch all road area data which match the input constraints.
List<ResponseModel>	getRoadLengthByCategory()	Fetch all road length by category data.
List<ResponseModel>	getRoadLengthByCategory(Collection<String> regions, Collection<String> categories, Collection<Integer> years)	Fetch all road length by category data which match the input constraints.
List<ResponseModel>	getRoadLengthByOwner()	Fetch all road length by road owner data.
List<ResponseModel>	getRoadLengthByOwner(Collection<String> regions, Collection<String> owners, Collection<Integer> years)	Fetch all road length by owner 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

EnvironmentLandUseInfrastructureForTransportClient

public EnvironmentLandUseInfrastructureForTransportClient()

Default constructor.

EnvironmentLandUseInfrastructureForTransportClient

public EnvironmentLandUseInfrastructureForTransportClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getRoadLengthByOwner

public List<ResponseModel> getRoadLengthByOwner()

Fetch all road length by road owner data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRoadLengthByOwner(Collection, Collection, Collection)

getRoadLengthByOwner

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

Fetch all road length by owner data which match the input constraints.

Parameters:

regions - the regions

owners - the owners

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getRailways

public List<ResponseModel> getRailways()

Fetch all railways data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRailways(Collection, Collection)

getRailways

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

Fetch all railways data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getRoadArea

public List<ResponseModel> getRoadArea()

Fetch all road area data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRoadArea(Collection, Collection, Collection)

getRoadArea

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

Fetch all road area data which match the input constraints.

Parameters:

regions - the regions

areas - the areas

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getRoadLengthByCategory

public List<ResponseModel> getRoadLengthByCategory()

Fetch all road length by category data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getRoadLengthByCategory(Collection, Collection, Collection)

getRoadLengthByCategory

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

Fetch all road length by category data which match the input constraints.

Parameters:

regions - the regions

categories - the categories

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getLandWithTransportInfrastructure

public List<ResponseModel> getLandWithTransportInfrastructure()

Fetch all land with transport infrastructure data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLandWithTransportInfrastructure(Collection, Collection)

getLandWithTransportInfrastructure

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

Fetch all land with transport infrastructure 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