com.github.dannil.scbjavaclient.client

Class AbstractClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

Direct Known Subclasses:

AbstractContainerClient, AgricultureCerealCropsClient, AgricultureHoldingsClient, AgricultureLandUseClient, AgricultureLivestockClient, BusinessActivitiesAccomodationStatisticsMonthClient, BusinessActivitiesAccomodationStatisticsYearClient, BusinessActivitiesBalanceStatisticsClient, BusinessActivitiesDatabaseClient, BusinessActivitiesIndustrialCapacityUtilizationEconomicIndicatorsClient, BusinessActivitiesIndustrialCapacityUtilizationIndustrialCapacityUtilizationClient, BusinessActivitiesIndustrialInventoriesEconomicIndicatorsClient, BusinessActivitiesIndustrialInventoriesInventoriesClient, BusinessActivitiesInvestmentSurveyEconomicIndicatorsClient, BusinessActivitiesNonFinancialCorporationsClient, BusinessActivitiesNonProfitOrganizationsPrimaryStatisticsClient, BusinessActivitiesNonProfitOrganizationsSatelliteAccountsClient, BusinessActivitiesOrdersAndTurnoverOldTablesSNI2002Client, BusinessActivitiesOrdersAndTurnoverOldTablesSNI2007Client, BusinessActivitiesOrdersAndTurnoverOrdersAndTurnoverClient, BusinessActivitiesProductionIndexClient, BusinessActivitiesProductionValueIndexClient, EducationAndResearchActivityAfterTrainingClient, EducationAndResearchCommunityInnovationSurveyActivityClient, EducationAndResearchCommunityInnovationSurveyCooperationClient, EnergyAnnualStatisticsClient, EnergyMonthlyStatisticsClient, EnvironmentAirPollutantsClient, EnvironmentGreenhouseGasClient, EnvironmentIslandsClient, EnvironmentLandAndWaterAreaClient, EnvironmentLandUseBuildingsClient, EnvironmentLandUsedForTransportClient, EnvironmentLandUseInfrastructureForTransportClient, EnvironmentLandUsePlanningClient, EnvironmentLandUseUsageClient, EnvironmentLocalitiesAreasAndPopulationPopulationClient, EnvironmentPackagingAndPackagingWasteClient, EnvironmentProtectedNatureNatureTypesClient, EnvironmentProtectedNatureNumberAndAreaClient, EnvironmentProtectedNaturePopulationAndAccessibilityClient, EnvironmentSEEAAirEmissionsAccountsClient, EnvironmentSEEAEnergyAccountsClient, EnvironmentSEEAGoodsAndServicesSectorClient, EnvironmentSEEAMaterialFlowAccountsClient, EnvironmentSEEATaxesClient, EnvironmentShorelineLandUseLandUseClient, EnvironmentShorelineLandUseOldTablesClient, EnvironmentSmallerLocalitiesClient, EnvironmentWasteClient, FinancialMarketsBalanceOfPaymentsDirectInvestmentsClient, FinancialMarketsBalanceOfPaymentsEconomicIndicatorsClient, FinancialMarketsBalanceOfPaymentsInternationalInvestmentPositionClient, FinancialMarketsBalanceOfPaymentsPaymentsClient, FinancialMarketsBalanceOfPaymentsPortfolioInvestmentClient, FinancialMarketsEnterprisesClient, FinancialMarketsInstitutionsClient, FinancialMarketsInvestmentFundsClient, FinancialMarketsSecuritiesClient, FinancialMarketsShareholdersClient, FinancialMarketsStatisticsClaimsAndLiabilitiesClient, FinancialMarketsStatisticsDepositAndLendingClient, FinancialMarketsStatisticsEconomicIndicatorsClient, FinancialMarketsStatisticsKeyFiguresClient, FinancialMarketsStatisticsStatisticsClient, GoodsAndServicesFoodSalesClient, GoodsAndServicesForeignTradeGoodsCNClient, GoodsAndServicesForeignTradeGoodsEconomicIndicatorsClient, GoodsAndServicesForeignTradeGoodsSITCClient, GoodsAndServicesForeignTradeGoodsSPINClient, GoodsAndServicesForeignTradeGoodsTotalClient, GoodsAndServicesTurnoverServiceSectorOldTablesSNI2002Client, GoodsAndServicesTurnoverServiceSectorOldTablesSNI2007Client, GoodsAndServicesTurnoverServiceSectorTurnoverClient, LabourMarketCostIndexClient, LabourMarketGrossPayAggregateWagesClient, LabourMarketShortTermEmploymentPopulationClient, LabourMarketShortTermEmploymentSickLeaveClient, LivingConditionsFamiliesAdoptionsClient, LivingConditionsFamiliesHousingClient, LivingConditionsFamiliesLegalGuardiansClient, LivingConditionsFamiliesSiblingsClient, LivingConditionsSurveysEmploymentClient, LivingConditionsSurveysHealthClient, PopulationNameNewbornClient, PopulationNameRegisteredPersonsClient, PopulationProjectionsLatestAssumptionsClient, PopulationProjectionsLatestProjectionsClient, PopulationStatisticsAdopteesClient, PopulationStatisticsAmountClient, PopulationStatisticsAsylumSeekersClient, PopulationStatisticsAverageAgeClient, PopulationStatisticsBackgroundClient, PopulationStatisticsCitizenshipClient, PopulationStatisticsDeathsClient, PopulationStatisticsDensityClient, PopulationStatisticsForeignBornPersonsClient, PopulationStatisticsForeignCitizensClient, PopulationStatisticsHouseholdClient, PopulationStatisticsLiveBirthsClient, PopulationStatisticsMeanPopulationClient, PopulationStatisticsMigrationClient, PopulationStatisticsPartnershipClient, PopulationStatisticsVitalEventsClient, PricesAndConsumptionBPIClient, PricesAndConsumptionCCIFPIExcludingWageClient, PricesAndConsumptionCCIFPIIncludingWageClient, PricesAndConsumptionCPICPIFCTClient, PricesAndConsumptionCPIEconomicIndicatorsClient, PricesAndConsumptionCPIHICPClient, PricesAndConsumptionCPIKPIFClient, PricesAndConsumptionCPIPriceBasicAmountClient, PricesAndConsumptionPPIEconomicIndicatorsClient, PricesAndConsumptionPPISPIN2002MonthClient, PricesAndConsumptionPPISPIN2002YearClient, PricesAndConsumptionPPISPIN2007MonthlyAndQuarterlyClient, PricesAndConsumptionPPISPIN2007YearClient, PricesAndConsumptionPPISPIN2015MonthlyAndQuarterlyClient, PricesAndConsumptionPurchasingPowerParitiesClient, PublicFinancesAnnualAccountsBalanceSheetCountyClient, PublicFinancesAnnualAccountsBalanceSheetMunicipalityClient, PublicFinancesAnnualAccountsStatementAccountsCountyClient, PublicFinancesAnnualAccountsStatementAccountsMunicipalityClient, PublicFinancesAssetsAndLiabilitiesClient, PublicFinancesGovernmentDebtClient, PublicFinancesLocalTaxesClient, PublicFinancesPubliclyOwnedEnterprisesClient, PublicFinancesTaxAssessmentClient, TransportRegisteredVehiclesEconomicIndicatorsClient, TransportRegisteredVehiclesVehiclesClient

public abstract class AbstractClient
extends Object

Abstract class which specifies how clients should operate.

Since:

0.0.2

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClient() Default constructor.
protected	AbstractClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
protected String	doGetRequest(String url) Performs a GET request to the specified URL.
protected String	doPostRequest(String url, String query) Performs a POST request to the specified URL.
CommunicationProtocol	getCommunicationProtocol() Returns the communication protocol for this client instance.
Locale	getLocale() Retrieves the Locale for this client instance.
Locale	getLocalizationLocale() Returns the Locale used for the localization.
protected List<ResponseModel>	getResponseModels(String table) Retrieves the response models for a given table.
protected List<ResponseModel>	getResponseModels(String table, Map<String,Collection<?>> mappings) Retrieves the response models for a given table which match the input constraints.
protected URLEndpoint	getRootUrl() Determines the URL for the API based on the current Locale and communication protocol.
abstract URLEndpoint	getUrl() Returns the URL endpoint which this client represents.
void	setCommunicationProtocol(CommunicationProtocol communicationProtocol) Sets the communication protocol for this client instance.
void	setLocale(Locale locale) Sets the Locale for this client instance.
void	setLocalizationLocale(Locale loc) Changes the Locale used for the localization.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractClient

protected AbstractClient()

Default constructor.

AbstractClient

protected AbstractClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getCommunicationProtocol

public CommunicationProtocol getCommunicationProtocol()

Returns the communication protocol for this client instance.

Returns:

the CommunicationProtocol for this client instance

setCommunicationProtocol

public void setCommunicationProtocol(CommunicationProtocol communicationProtocol)

Sets the communication protocol for this client instance.

Parameters:

communicationProtocol - the CommunicationProtocol for this client instance

getLocale

public Locale getLocale()

Retrieves the Locale for this client instance.

Returns:

the Locale for this client instance

setLocale

public void setLocale(Locale locale)

Sets the Locale for this client instance. Note that doing this after a call to setLocalizationLocale(Locale) overwrites the localization language with the input of this method.

Parameters:

locale - the Locale for this client

getLocalizationLocale

public Locale getLocalizationLocale()

Returns the Locale used for the localization.

Returns:

locale the Locale for the localization

setLocalizationLocale

public void setLocalizationLocale(Locale loc)

Changes the Locale used for the localization. Useful if the client needs to be in a different language than the error messages.

Parameters:

loc - the Locale for the localization

getRootUrl

protected URLEndpoint getRootUrl()

Determines the URL for the API based on the current Locale and communication protocol.

Returns:

the URL representing the entry point for the API

doGetRequest

protected String doGetRequest(String url)

Performs a GET request to the specified URL.

Parameters:

url - the URL which will be sent a GET request

Returns:

a string representation of the API's response

doPostRequest

protected String doPostRequest(String url,
                               String query)

Performs a POST request to the specified URL.

Parameters:

url - the URL which will be sent a POST request

query - the query which the API will process

Returns:

a string representation of the API's response

getResponseModels

protected List<ResponseModel> getResponseModels(String table)

Retrieves the response models for a given table.

Parameters:

table - the table

Returns:

a list of ResponseModel

getResponseModels

protected List<ResponseModel> getResponseModels(String table,
                                                Map<String,Collection<?>> mappings)

Retrieves the response models for a given table which match the input constraints.

Parameters:

table - the table

mappings - the mappings

Returns:

a list of ResponseModel

getUrl

public abstract URLEndpoint getUrl()

Returns the URL endpoint which this client represents.

Returns:

the URL endpoint for this client