Package com.github.dannil.scbjavaclient.client.energy.annualstatistics

Class EnergyAnnualStatisticsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.energy.annualstatistics.EnergyAnnualStatisticsClient

public class EnergyAnnualStatisticsClient
extends AbstractClient

Client which handles energy annual statistics data fetching.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getConsumptionOfFuelsForSteamAndHotWaterProduction()	Fetch all consumption of fuels for steam and hot water production data.
List<ResponseModel>	getConsumptionOfFuelsForSteamAndHotWaterProduction(Collection<String> powerPlants, Collection<String> fuels, Collection<Integer> years)	Fetch all consumption of fuels for steam and hot water production data which match the input constraints.
List<ResponseModel>	getConsumptionOfFuelsInElectricityGeneration()	Fetch all consumption of fuels in electricity generation data.
List<ResponseModel>	getConsumptionOfFuelsInElectricityGeneration(Collection<String> powerPlants, Collection<String> fuels, Collection<Integer> years)	Fetch all consumption of fuels in electricity generation data which match the input constraints.
List<ResponseModel>	getElectricitySupply()	Fetch all electricity supply data.
List<ResponseModel>	getElectricitySupply(Collection<String> powerPlants, Collection<Integer> years)	Fetch all electricity supply data which match the input constraints.
List<ResponseModel>	getElectricityUseInSweden()	Fetch all electricity use in Sweden data.
List<ResponseModel>	getElectricityUseInSweden(Collection<String> areasOfUses, Collection<Integer> years)	Fetch all electricity use in Sweden 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

EnergyAnnualStatisticsClient

public EnergyAnnualStatisticsClient()

Default constructor.

EnergyAnnualStatisticsClient

public EnergyAnnualStatisticsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getConsumptionOfFuelsInElectricityGeneration

public List<ResponseModel> getConsumptionOfFuelsInElectricityGeneration()

Fetch all consumption of fuels in electricity generation data.

Returns:

the consumption of fuels in electricity generation data wrapped in a list of ResponseModel objects

See Also:

getConsumptionOfFuelsInElectricityGeneration(Collection, Collection, Collection)

getConsumptionOfFuelsInElectricityGeneration

public List<ResponseModel> getConsumptionOfFuelsInElectricityGeneration(Collection<String> powerPlants,
                                                                        Collection<String> fuels,
                                                                        Collection<Integer> years)

Fetch all consumption of fuels in electricity generation data which match the input constraints.

Parameters:

powerPlants - the power plants to fetch data for

fuels - the fuels to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getElectricitySupply

public List<ResponseModel> getElectricitySupply()

Fetch all electricity supply data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getElectricitySupply(Collection, Collection)

getElectricitySupply

public List<ResponseModel> getElectricitySupply(Collection<String> powerPlants,
                                                Collection<Integer> years)

Fetch all electricity supply data which match the input constraints.

Parameters:

powerPlants - the power plants to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getConsumptionOfFuelsForSteamAndHotWaterProduction

public List<ResponseModel> getConsumptionOfFuelsForSteamAndHotWaterProduction()

Fetch all consumption of fuels for steam and hot water production data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getConsumptionOfFuelsForSteamAndHotWaterProduction(Collection, Collection, Collection)

getConsumptionOfFuelsForSteamAndHotWaterProduction

public List<ResponseModel> getConsumptionOfFuelsForSteamAndHotWaterProduction(Collection<String> powerPlants,
                                                                              Collection<String> fuels,
                                                                              Collection<Integer> years)

Fetch all consumption of fuels for steam and hot water production data which match the input constraints.

Parameters:

powerPlants - the power plants to fetch data for

fuels - the fuels to fetch data for

years - the years to fetch data for

Returns:

the data wrapped in a list of ResponseModel objects

getElectricityUseInSweden

public List<ResponseModel> getElectricityUseInSweden()

Fetch all electricity use in Sweden data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getElectricityUseInSweden(Collection, Collection)

getElectricityUseInSweden

public List<ResponseModel> getElectricityUseInSweden(Collection<String> areasOfUses,
                                                     Collection<Integer> years)

Fetch all electricity use in Sweden data which match the input constraints.

Parameters:

areasOfUses - the areas of uses 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