Merge pull request #65 from JavaMoney/add_ecb_history_90

adds ECBHistoric90RateProviderTest

Author: Otávio Santana

src/main/java/org/javamoney/moneta/convert/internal/ECBHistoric90RateProvider.java

@@ -16,17 +16,26 @@
 package org.javamoney.moneta.convert.internal;
 
 import java.io.InputStream;
-import java.math.BigDecimal;
+import java.math.MathContext;
 import java.net.MalformedURLException;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.*;
+import java.time.LocalDate;
+import java.time.ZoneId;
+import java.util.Comparator;
+import java.util.Date;
+import java.util.Map;
+import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.logging.Level;
 
 import javax.money.CurrencyUnit;
 import javax.money.MonetaryCurrencies;
-import javax.money.convert.*;
+import javax.money.convert.ConversionContext;
+import javax.money.convert.ConversionContextBuilder;
+import javax.money.convert.ConversionQuery;
+import javax.money.convert.ExchangeRate;
+import javax.money.convert.ProviderContext;
+import javax.money.convert.ProviderContextBuilder;
+import javax.money.convert.RateType;
 import javax.money.spi.Bootstrap;
 import javax.xml.parsers.SAXParser;
 import javax.xml.parsers.SAXParserFactory;
@@ -36,9 +45,6 @@
 import org.javamoney.moneta.spi.DefaultNumberValue;
 import org.javamoney.moneta.spi.LoaderService;
 import org.javamoney.moneta.spi.LoaderService.LoaderListener;
-import org.xml.sax.Attributes;
-import org.xml.sax.SAXException;
-import org.xml.sax.helpers.DefaultHandler;
 
 /**
  * This class implements an {@link javax.money.convert.ExchangeRateProvider} that loads data from
@@ -50,12 +56,12 @@
  * @author Werner Keil
  */
 public class ECBHistoric90RateProvider extends AbstractRateProvider implements LoaderListener{
-    /**
+	  /**
      * The data id used for the LoaderService.
      */
     private static final String DATA_ID = ECBHistoric90RateProvider.class.getSimpleName();
+    static final String BASE_CURRENCY_CODE = "EUR";
 
-    private static final String BASE_CURRENCY_CODE = "EUR";
     /**
      * Base currency of the loaded rates is always EUR.
      */
@@ -64,7 +70,7 @@ public class ECBHistoric90RateProvider extends AbstractRateProvider implements L
     /**
      * Historic exchange rates, rate timestamp as UTC long.
      */
-    private final Map<Long,Map<String,ExchangeRate>> rates = new ConcurrentHashMap<>();
+	private final Map<Long, Map<String, ExchangeRate>> historicRates = new ConcurrentHashMap<>();
     /**
      * Parser factory.
      */
@@ -76,7 +82,9 @@ public class ECBHistoric90RateProvider extends AbstractRateProvider implements L
             ProviderContextBuilder.of("ECB-HIST90", RateType.HISTORIC, RateType.DEFERRED)
                     .set("providerDescription", "European Central Bank (last 90 days)").set("days", 90).build();
 
-    /**
+    private Long recentKey;
+
+    /*
      * Constructor, also loads initial data.
      *
      * @throws MalformedURLException
@@ -90,178 +98,126 @@ public ECBHistoric90RateProvider() throws MalformedURLException{
         loader.loadDataAsync(DATA_ID);
     }
 
-    /**
-     * (Re)load the given data feed. Logs an error if loading fails.
-     */
     @Override
     public void newDataLoaded(String data, InputStream is){
-        final int oldSize = this.rates.size();
+        final int oldSize = this.historicRates.size();
         try{
             SAXParser parser = saxParserFactory.newSAXParser();
-            parser.parse(is, new RateReadingHandler());
+            parser.parse(is, new RateReadingHandler(historicRates, CONTEXT));
+            recentKey = null;
         }
         catch(Exception e){
             LOGGER.log(Level.FINEST, "Error during data load.", e);
         }
-        int newSize = this.rates.size();
+        int newSize = this.historicRates.size();
         LOGGER.info("Loaded " + DATA_ID + " exchange rates for days:" + (newSize - oldSize));
     }
 
-    public ExchangeRate getExchangeRate(ConversionQuery conversionQuery){
-        ExchangeRate sourceRate;
-        ExchangeRate target;
-        if(Objects.isNull(conversionQuery.getTimestampMillis())){
-            return null;
-        }
-        ExchangeRateBuilder builder = new ExchangeRateBuilder(
-                ConversionContextBuilder.create(CONTEXT, RateType.HISTORIC)
-                        .setTimestampMillis(conversionQuery.getTimestampMillis()).build());
-        if(rates.isEmpty()){
+    /*
+     * (non-Javadoc)
+     *
+     * @see javax.money.convert.spi.ExchangeRateProviderSpi#getExchangeRateType
+     * ()
+     */
+    @Override
+    public ProviderContext getProviderContext(){
+        return CONTEXT;
+    }
+
+    @Override
+	public ExchangeRate getExchangeRate(ConversionQuery query){
+    	if(historicRates.isEmpty()){
             return null;
         }
-        final Calendar cal = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
-        cal.setTimeInMillis(conversionQuery.getTimestampMillis());
-        cal.set(Calendar.HOUR, 0);
-        cal.set(Calendar.MINUTE, 0);
-        cal.set(Calendar.SECOND, 0);
-        cal.set(Calendar.MILLISECOND, 0);
-        Long targetTS = cal.getTimeInMillis();
 
-        builder.setBase(conversionQuery.getBaseCurrency());
-        builder.setTerm(conversionQuery.getCurrency());
-        Map<String,ExchangeRate> targets = this.rates.get(targetTS);
+		Long timeStampMillis = getMillisSeconds(query);
+        ExchangeRateBuilder builder = getBuilder(query, timeStampMillis);
+
+
+		Map<String, ExchangeRate> targets = this.historicRates
+				.get(timeStampMillis);
         if(Objects.isNull(targets)){
             return null;
         }
-        sourceRate = targets.get(conversionQuery.getBaseCurrency().getCurrencyCode());
-        target = targets.get(conversionQuery.getCurrency().getCurrencyCode());
-        if(BASE_CURRENCY_CODE.equals(conversionQuery.getBaseCurrency().getCurrencyCode()) &&
-                BASE_CURRENCY_CODE.equals(conversionQuery.getCurrency().getCurrencyCode())){
+		ExchangeRate sourceRate = targets.get(query.getBaseCurrency()
+				.getCurrencyCode());
+		ExchangeRate target = targets
+				.get(query.getCurrency().getCurrencyCode());
+        return createExchangeRate(query, builder, sourceRate, target);
+    }
+
+	private ExchangeRate createExchangeRate(ConversionQuery query,
+			ExchangeRateBuilder builder, ExchangeRate sourceRate,
+			ExchangeRate target) {
+
+		if(areBothBaseCurrencies(query)){
             builder.setFactor(DefaultNumberValue.ONE);
             return builder.build();
-        }else if(BASE_CURRENCY_CODE.equals(conversionQuery.getCurrency().getCurrencyCode())){
+        } else if(BASE_CURRENCY_CODE.equals(query.getCurrency().getCurrencyCode())){
             if(Objects.isNull(sourceRate)){
                 return null;
             }
-            return getReversed(sourceRate);
-        }else if(BASE_CURRENCY_CODE.equals(conversionQuery.getBaseCurrency().getCurrencyCode())){
+            return reverse(sourceRate);
+		} else if (BASE_CURRENCY_CODE.equals(query.getBaseCurrency()
+				.getCurrencyCode())) {
             return target;
-        }else{
+        } else{
             // Get Conversion base as derived rate: base -> EUR -> term
             ExchangeRate rate1 = getExchangeRate(
-                    conversionQuery.toBuilder().setBaseCurrency(conversionQuery.getBaseCurrency())
-                            .setTermCurrency(MonetaryCurrencies.getCurrency(BASE_CURRENCY_CODE)).build());
+                    query.toBuilder().setTermCurrency(MonetaryCurrencies.getCurrency(BASE_CURRENCY_CODE)).build());
             ExchangeRate rate2 = getExchangeRate(
-                    conversionQuery.toBuilder().setBaseCurrency(MonetaryCurrencies.getCurrency(BASE_CURRENCY_CODE))
-                            .setTermCurrency(conversionQuery.getCurrency()).build());
+                    query.toBuilder().setBaseCurrency(MonetaryCurrencies.getCurrency(BASE_CURRENCY_CODE))
+                            .setTermCurrency(query.getCurrency()).build());
             if(Objects.nonNull(rate1) || Objects.nonNull(rate2)){
                 builder.setFactor(multiply(rate1.getFactor(), rate2.getFactor()));
                 builder.setRateChain(rate1, rate2);
                 return builder.build();
             }
             return null;
         }
-    }
-
-    /**
-     * SAX Event Handler that reads the quotes.
-     * <p>
-     * Format: <gesmes:Envelope
-     * xmlns:gesmes="http://www.gesmes.org/xml/2002-08-01"
-     * xmlns="http://www.ecb.int/vocabulary/2002-08-01/eurofxref">
-     * <gesmes:subject>Reference rates</gesmes:subject> <gesmes:Sender>
-     * <gesmes:name>European Central Bank</gesmes:name> </gesmes:Sender> <Cube>
-     * <Cube time="2013-02-21">...</Cube> <Cube time="2013-02-20">...</Cube>
-     * <Cube time="2013-02-19"> <Cube currency="USD" rate="1.3349"/> <Cube
-     * currency="JPY" rate="124.81"/> <Cube currency="BGN" rate="1.9558"/> <Cube
-     * currency="CZK" rate="25.434"/> <Cube currency="DKK" rate="7.4599"/> <Cube
-     * currency="GBP" rate="0.8631"/> <Cube currency="HUF" rate="290.79"/> <Cube
-     * currency="LTL" rate="3.4528"/> ...
-     *
-     * @author Anatole Tresch
-     */
-    private class RateReadingHandler extends DefaultHandler{
-
-        /**
-         * Date parser.
-         */
-        private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
-        /**
-         * Current timestamp for the given section.
-         */
-        private Long timestamp;
-
-        /** Flag, if current or historic data is loaded. */
-        // private boolean loadCurrent;
-
-        /**
-         * Creates a new parser.
-         */
-        public RateReadingHandler(){
-            dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
-        }
-
-        /*
-         * (non-Javadoc)
-         *
-         * @see
-         * org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String,
-         * java.lang.String, java.lang.String, org.xml.sax.Attributes)
-         */
-        @Override
-        public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException{
-            try{
-                if("Cube".equals(qName)){
-                    if(Objects.nonNull(attributes.getValue("time"))){
-                        Date date = dateFormat.parse(attributes.getValue("time"));
-                        timestamp = date.getTime();
-                    }else if(Objects.nonNull(attributes.getValue("currency"))){
-                        // read data <Cube currency="USD" rate="1.3349"/>
-                        CurrencyUnit tgtCurrency = MonetaryCurrencies.getCurrency(attributes.getValue("currency"));
-                        addRate(tgtCurrency, timestamp,
-                                BigDecimal.valueOf(Double.parseDouble(attributes.getValue("rate"))));
-                    }
-                }
-                super.startElement(uri, localName, qName, attributes);
-            }
-            catch(ParseException e){
-                throw new SAXException("Failed to read.", e);
-            }
-        }
-
-    }
-
-    /**
-     * Method to add a currency exchange rate.
-     *
-     * @param term      the term (target) currency, mapped from EUR.
-     * @param timestamp The target day.
-     * @param rate      The rate.
-     */
-    void addRate(CurrencyUnit term, Long timestamp, Number rate){
-        ExchangeRateBuilder builder;
-        RateType rateType = RateType.HISTORIC;
-        if(Objects.nonNull(timestamp)){
-            if(timestamp > System.currentTimeMillis()){
-                rateType = RateType.DEFERRED;
-            }
-            builder = new ExchangeRateBuilder(
-                    ConversionContextBuilder.create(CONTEXT, rateType).setTimestampMillis(timestamp).build());
-        }else{
-            builder = new ExchangeRateBuilder(ConversionContext.of(CONTEXT.getProvider(), rateType));
-        }
-        builder.setBase(BASE_CURRENCY);
-        builder.setTerm(term);
-        builder.setFactor(new DefaultNumberValue(rate));
-        ExchangeRate exchangeRate = builder.build();
-        Map<String,ExchangeRate> rateMap = this.rates.get(timestamp);
-        if(Objects.isNull(rateMap)){
-            synchronized(this.rates){
-                rateMap = Optional.ofNullable(this.rates.get(timestamp)).orElse(new ConcurrentHashMap<>());
-                this.rates.putIfAbsent(timestamp, rateMap);
-            }
+	}
+
+	private boolean areBothBaseCurrencies(ConversionQuery query) {
+		return BASE_CURRENCY_CODE.equals(query.getBaseCurrency().getCurrencyCode()) &&
+                BASE_CURRENCY_CODE.equals(query.getCurrency().getCurrencyCode());
+	}
+
+	private Long getMillisSeconds(ConversionQuery query) {
+		if (Objects.nonNull(query.getTimestamp())) {
+			LocalDate timeStamp = query.getTimestamp().toLocalDate();
+
+			Date date = Date.from(timeStamp.atStartOfDay()
+					.atZone(ZoneId.systemDefault()).toInstant());
+			Long timeStampMillis = date.getTime();
+			return timeStampMillis;
+		} else {
+			return getRecentKey();
+		}
+	}
+
+	private Long getRecentKey() {
+		if(Objects.isNull(recentKey)) {
+			Comparator<Long> reversed = Comparator.<Long>naturalOrder().reversed();
+			recentKey =  historicRates.keySet().stream().sorted(reversed).findFirst().get();
+		}
+		return recentKey;
+	}
+
+	private ExchangeRateBuilder getBuilder(ConversionQuery query,
+			Long timeStampMillis) {
+		ExchangeRateBuilder builder = new ExchangeRateBuilder(
+                ConversionContextBuilder.create(CONTEXT, RateType.HISTORIC)
+						.setTimestampMillis(timeStampMillis).build());
+        builder.setBase(query.getBaseCurrency());
+        builder.setTerm(query.getCurrency());
+		return builder;
+	}
+
+    private ExchangeRate reverse(ExchangeRate rate){
+        if(Objects.isNull(rate)){
+            throw new IllegalArgumentException("Rate null is not reversable.");
         }
-        rateMap.put(term.getCurrencyCode(), exchangeRate);
+        return new ExchangeRateBuilder(rate).setRate(rate).setBase(rate.getCurrency()).setTerm(rate.getBaseCurrency())
+                .setFactor(divide(DefaultNumberValue.ONE, rate.getFactor(), MathContext.DECIMAL64)).build();
     }
-
 }

src/main/java/org/javamoney/moneta/convert/internal/ECBHistoricRateProvider.java

@@ -90,7 +90,7 @@ public class ECBHistoricRateProvider extends AbstractRateProvider implements
     /**
      * The {@link ConversionContext} of this provider.
      */
-    static final ProviderContext CONTEXT =
+    private static final ProviderContext CONTEXT =
             ProviderContextBuilder.of("ECB-HIST", RateType.HISTORIC, RateType.DEFERRED)
                     .set("providerDescription", "European Central Bank").set("days", 1500).build();
 
@@ -115,7 +115,7 @@ public void newDataLoaded(String data, InputStream is){
         final int oldSize = this.historicRates.size();
         try{
             SAXParser parser = saxParserFactory.newSAXParser();
-            parser.parse(is, new RateReadingHandler(historicRates));
+            parser.parse(is, new RateReadingHandler(historicRates, CONTEXT));
             recentKey = null;
         }
         catch(Exception e){

src/main/java/org/javamoney/moneta/convert/internal/RateReadingHandler.java

@@ -13,6 +13,7 @@
 import javax.money.MonetaryCurrencies;
 import javax.money.convert.ConversionContextBuilder;
 import javax.money.convert.ExchangeRate;
+import javax.money.convert.ProviderContext;
 import javax.money.convert.RateType;
 
 import org.javamoney.moneta.ExchangeRateBuilder;
@@ -47,8 +48,11 @@ class RateReadingHandler extends DefaultHandler{
 
 	private final Map<Long, Map<String, ExchangeRate>> historicRates;
 
-	public RateReadingHandler(Map<Long, Map<String, ExchangeRate>> historicRates) {
+	private ProviderContext context;
+
+	public RateReadingHandler(Map<Long, Map<String, ExchangeRate>> historicRates, ProviderContext context) {
 		this.historicRates = historicRates;
+		this.context = context;
 	}
 
 	@Override
@@ -86,9 +90,9 @@ void addRate(CurrencyUnit term, long timestamp, Number rate) {
                 rateType = RateType.DEFERRED;
             }
             builder = new ExchangeRateBuilder(
-                    ConversionContextBuilder.create(ECBHistoricRateProvider.CONTEXT, rateType).setTimestampMillis(timestamp).build());
+                    ConversionContextBuilder.create(context, rateType).setTimestampMillis(timestamp).build());
         }else{
-            builder = new ExchangeRateBuilder(ConversionContextBuilder.create(ECBHistoricRateProvider.CONTEXT, rateType).build());
+            builder = new ExchangeRateBuilder(ConversionContextBuilder.create(context, rateType).build());
         }
         builder.setBase(ECBHistoricRateProvider.BASE_CURRENCY);
         builder.setTerm(term);