de.richtercloud.reflection.form.builder.components.money

Class CachedOnlineAmountMoneyExchangeRateRetriever

java.lang.Object

de.richtercloud.reflection.form.builder.components.money.OnlineAmountMoneyExchangeRateRetriever

de.richtercloud.reflection.form.builder.components.money.CachedOnlineAmountMoneyExchangeRateRetriever

All Implemented Interfaces:

AmountMoneyExchangeRateRetriever

Direct Known Subclasses:

ECBAmountMoneyExchangeRateRetriever, FixerAmountMoneyExchangeRateRetriever

public abstract class CachedOnlineAmountMoneyExchangeRateRetriever
extends OnlineAmountMoneyExchangeRateRetriever

Author:

richter

Field Summary

Fields

Modifier and Type	Field and Description
static long	FILE_CACHE_EXPIRATION_MILLIS_DEFAULT

Constructor Summary

Constructors

Constructor and Description
CachedOnlineAmountMoneyExchangeRateRetriever(File fileCacheFile, long fileCacheExpirationMillis, String initialResultResourceName)
CachedOnlineAmountMoneyExchangeRateRetriever(File fileCacheFile, String initialResultResourceName)

Method Summary

Modifier and Type	Method and Description
double	fetchConversionRate(org.jscience.economics.money.Currency currency) Doesn't cache since results are already cached in super class.
protected abstract org.apache.commons.lang3.tuple.Pair<Map<org.jscience.economics.money.Currency,Double>,org.jscience.economics.money.Currency>	fetchResult() Allows to retrieve the complete cache at once which makes sense for subclasses which will retrieve a list of currency exchange rates rather than a single result (probably all).
org.apache.commons.lang3.tuple.Pair<Map<org.jscience.economics.money.Currency,Double>,org.jscience.economics.money.Currency>	getResult()
Set<org.jscience.economics.money.Currency>	getSupportedCurrencies() Gets a set of supported currencies from the mechanism used for retrieval of exchange rates.
protected abstract String	getUrl()

Methods inherited from class de.richtercloud.reflection.form.builder.components.money.OnlineAmountMoneyExchangeRateRetriever

retrieveExchangeRate

Methods inherited from class java.lang.Object

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

Field Detail

FILE_CACHE_EXPIRATION_MILLIS_DEFAULT

public static final long FILE_CACHE_EXPIRATION_MILLIS_DEFAULT

See Also:

Constant Field Values

Constructor Detail

CachedOnlineAmountMoneyExchangeRateRetriever

public CachedOnlineAmountMoneyExchangeRateRetriever(File fileCacheFile,
                                                    String initialResultResourceName)

CachedOnlineAmountMoneyExchangeRateRetriever

public CachedOnlineAmountMoneyExchangeRateRetriever(File fileCacheFile,
                                                    long fileCacheExpirationMillis,
                                                    String initialResultResourceName)

Method Detail

getResult

public org.apache.commons.lang3.tuple.Pair<Map<org.jscience.economics.money.Currency,Double>,org.jscience.economics.money.Currency> getResult()
                                                                                                                                       throws AmountMoneyExchangeRateRetrieverException

Throws:

AmountMoneyExchangeRateRetrieverException

fetchResult

protected abstract org.apache.commons.lang3.tuple.Pair<Map<org.jscience.economics.money.Currency,Double>,org.jscience.economics.money.Currency> fetchResult()
                                                                                                                                                     throws AmountMoneyExchangeRateRetrieverException,
                                                                                                                                                            AmountMoneyExchangeRateRetrievalException

Allows to retrieve the complete cache at once which makes sense for subclasses which will retrieve a list of currency exchange rates rather than a single result (probably all).

Returns:

the retrieved exchange rate data

Throws:

AmountMoneyExchangeRateRetrieverException - if an exception unrelated to a network failure or missing network connection occured

AmountMoneyExchangeRateRetrievalException - if an exception related to a network failure or missing network connection occured

getSupportedCurrencies

public Set<org.jscience.economics.money.Currency> getSupportedCurrencies()
                                                                  throws AmountMoneyExchangeRateRetrieverException

Description copied from interface: AmountMoneyExchangeRateRetriever

Gets a set of supported currencies from the mechanism used for retrieval of exchange rates.

Returns:

the set of supported currencies

Throws:

AmountMoneyExchangeRateRetrieverException - if an exception unrelated to a network failure or missing network connection occured

fetchConversionRate

public double fetchConversionRate(org.jscience.economics.money.Currency currency)
                           throws AmountMoneyExchangeRateRetrieverException

Doesn't cache since results are already cached in super class.

Specified by:

fetchConversionRate in class OnlineAmountMoneyExchangeRateRetriever

Parameters:

currency - the currency to fetch for

Returns:

the fetched conversion rate

Throws:

AmountMoneyExchangeRateRetrieverException - if an exception unrelated to a network failure or missing network connection occured

getUrl

protected abstract String getUrl()