com.github.dannil.scbjavaclient.client.environment.industrialwateruse

Class EnvironmentIndustrialWaterUseClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.industrialwateruse.EnvironmentIndustrialWaterUseClient

public class EnvironmentIndustrialWaterUseClient
extends AbstractClient

Client which handles environment industrial water use data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getUrl() Returns the URL endpoint which this client represents.
List<WaterAbstraction>	getWaterAbstraction() Fetch all water abstraction data.
List<WaterAbstraction>	getWaterAbstraction(Collection<String> regions, Collection<Integer> type, Collection<Integer> years) Fetch all water abstraction data which match the input constraints.
List<WaterDischarge>	getWaterDischarge() Fetch all water discharge data.
List<WaterDischarge>	getWaterDischarge(Collection<String> regions, Collection<Integer> type, Collection<Integer> years) Fetch all water discharge data which match the input constraints.
List<WaterUse>	getWaterUse() Fetch all water use data.
List<WaterUse>	getWaterUse(Collection<String> regions, Collection<Integer> type, Collection<Integer> years) Fetch all water use data which match the input constraints.

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

doGetRequest, doPostRequest, getLocale, getLocalizationLocale, getRootUrl, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentIndustrialWaterUseClient

public EnvironmentIndustrialWaterUseClient()

Default constructor.

EnvironmentIndustrialWaterUseClient

public EnvironmentIndustrialWaterUseClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getWaterAbstraction

public List<WaterAbstraction> getWaterAbstraction()

Fetch all water abstraction data.

Returns:

the water abstraction data wrapped in a list of WaterAbstraction objects

See Also:

getWaterAbstraction(Collection, Collection, Collection)

getWaterAbstraction

public List<WaterAbstraction> getWaterAbstraction(Collection<String> regions,
                                                  Collection<Integer> type,
                                                  Collection<Integer> years)

Fetch all water abstraction data which match the input constraints.

Parameters:

regions - the regions to fetch data for

type - the type to fetch data for

years - the years to fetch data for

Returns:

the water abstraction data wrapped in a list of WaterAbstraction objects

getWaterUse

public List<WaterUse> getWaterUse()

Fetch all water use data.

Returns:

the water use data wrapped in a list of WaterUse objects

See Also:

getWaterUse(Collection, Collection, Collection)

getWaterUse

public List<WaterUse> getWaterUse(Collection<String> regions,
                                  Collection<Integer> type,
                                  Collection<Integer> years)

Fetch all water use data which match the input constraints.

Parameters:

regions - the regions to fetch data for

type - the type to fetch data for

years - the years to fetch data for

Returns:

the water use data wrapped in a list of WaterUse objects

getWaterDischarge

public List<WaterDischarge> getWaterDischarge()

Fetch all water discharge data.

Returns:

the water discharge data wrapped in a list of WaterDischarge objects

See Also:

getWaterDischarge(Collection, Collection, Collection)

getWaterDischarge

public List<WaterDischarge> getWaterDischarge(Collection<String> regions,
                                              Collection<Integer> type,
                                              Collection<Integer> years)

Fetch all water discharge data which match the input constraints.

Parameters:

regions - the regions to fetch data for

type - the type to fetch data for

years - the years to fetch data for

Returns:

the water abstraction data wrapped in a list of WaterDischarge objects

getUrl

public String 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