com.github.dannil.scbjavaclient.client.agriculture.cerealcrops

Class AgricultureCerealCropsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.agriculture.cerealcrops.AgricultureCerealCropsClient

public class AgricultureCerealCropsClient
extends AbstractClient

Client which handles agriculture cereal crops data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
URLEndpoint	getUrl() Returns the URL endpoint which this client represents.
List<ResponseModel>	getYieldPerHectarAndTotalProduction() Fetch all yield per hectar and total production data.
List<ResponseModel>	getYieldPerHectarAndTotalProduction(Collection<String> regions, Collection<Integer> crops, Collection<Integer> years) Fetch all yield per hectar and total production data which match the input constraints.

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

AgricultureCerealCropsClient

public AgricultureCerealCropsClient()

Default constructor.

AgricultureCerealCropsClient

public AgricultureCerealCropsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getYieldPerHectarAndTotalProduction

public List<ResponseModel> getYieldPerHectarAndTotalProduction()

Fetch all yield per hectar and total production data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getYieldPerHectarAndTotalProduction(Collection, Collection, Collection)

getYieldPerHectarAndTotalProduction

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

Fetch all yield per hectar and total production data which match the input constraints.

Parameters:

regions - the regions

crops - the crops

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