#23[1h]. Add IReport, IExchangeRepoProvider interfaces. Add base implementations.

Author: Evgenii Kanivets

app/src/main/java/com/blogspot/e_kanivets/moneytracker/model/Report.java

@@ -5,12 +5,12 @@
 import com.blogspot.e_kanivets.moneytracker.R;
 import com.blogspot.e_kanivets.moneytracker.MtApp;
 import com.blogspot.e_kanivets.moneytracker.controller.ExchangeRateController;
+import com.blogspot.e_kanivets.moneytracker.report.ExchangeRateProvider;
+import com.blogspot.e_kanivets.moneytracker.report.base.IExchangeRateProvider;
 
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
-import java.util.TreeMap;
 
 /**
  * Created on 11/09/14.
@@ -20,18 +20,17 @@
 public class Report {
     private List<Record> records;
     private String currency;
-    private ExchangeRateController exchangeRateController;
     private List<Record> summaryRecordList;
     private List<Pair<String, Integer>> reportList;
     private List<Pair<String, Integer>> summaryReportList;
-    private Map<String, ExchangeRate> rateMap;
+
+    private IExchangeRateProvider rateProvider;
 
     public Report(List<Record> records, String currency, ExchangeRateController exchangeRateController) {
         this.records = records;
         this.currency = currency;
-        this.exchangeRateController = exchangeRateController;
+        rateProvider = new ExchangeRateProvider(currency, exchangeRateController);
 
-        rateMap = initRateMap();
         makeReport();
     }
 
@@ -63,7 +62,7 @@ private void makeReport() {
 
             int convertedPrice = record.getPrice();
             if (!currency.equals(record.getCurrency())) {
-                ExchangeRate rate = rateMap.get(record.getCurrency());
+                ExchangeRate rate = rateProvider.getRate(record);
                 if (rate != null) convertedPrice *= rate.getAmount();
             }
 
@@ -180,17 +179,4 @@ private void sortRecordList(List<Record> list) {
             }
         }
     }
-
-    private Map<String, ExchangeRate> initRateMap() {
-        Map<String, ExchangeRate> rateMap = new TreeMap<>();
-
-        for (ExchangeRate rate : exchangeRateController.readAll()) {
-            if (!currency.equals(rate.getToCurrency())) continue;
-            if (rateMap.containsKey(rate.getFromCurrency())) continue;
-
-            rateMap.put(rate.getFromCurrency(), rate);
-        }
-
-        return rateMap;
-    }
 }

app/src/main/java/com/blogspot/e_kanivets/moneytracker/report/ExchangeRateProvider.java

@@ -0,0 +1,62 @@
+package com.blogspot.e_kanivets.moneytracker.report;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.blogspot.e_kanivets.moneytracker.controller.ExchangeRateController;
+import com.blogspot.e_kanivets.moneytracker.model.ExchangeRate;
+import com.blogspot.e_kanivets.moneytracker.model.Record;
+import com.blogspot.e_kanivets.moneytracker.report.base.IExchangeRateProvider;
+
+import java.util.Map;
+import java.util.TreeMap;
+
+/**
+ * First {@link IExchangeRateProvider} implementation.
+ * Created on 2/25/16.
+ *
+ * @author Evgenii Kanivets
+ */
+public class ExchangeRateProvider implements IExchangeRateProvider {
+    @SuppressWarnings("unused")
+    private static final String TAG = "ExchangeRateProvider";
+
+    private String toCurrency;
+    private final ExchangeRateController controller;
+    private final Map<String, ExchangeRate> rateMap;
+
+    /**
+     * @param toCurrency code of toCurrency to convert to
+     * @param controller dependency to get needed rates
+     */
+    public ExchangeRateProvider(String toCurrency, ExchangeRateController controller) {
+        this.toCurrency = toCurrency;
+        this.controller = controller;
+
+        rateMap = getRateMap();
+    }
+
+    @Nullable
+    @Override
+    public ExchangeRate getRate(@Nullable Record record) {
+        if (record == null) return null;
+
+        String fromCurrency = record.getCurrency();
+
+        return rateMap.get(fromCurrency);
+    }
+
+    @NonNull
+    private Map<String, ExchangeRate> getRateMap() {
+        Map<String, ExchangeRate> rateMap = new TreeMap<>();
+
+        for (ExchangeRate rate : controller.readAll()) {
+            if (!toCurrency.equals(rate.getToCurrency())) continue;
+            if (rateMap.containsKey(rate.getFromCurrency())) continue;
+
+            rateMap.put(rate.getFromCurrency(), rate);
+        }
+
+        return rateMap;
+    }
+}

app/src/main/java/com/blogspot/e_kanivets/moneytracker/report/Report.java

@@ -0,0 +1,71 @@
+package com.blogspot.e_kanivets.moneytracker.report;
+
+import android.support.annotation.NonNull;
+
+import com.blogspot.e_kanivets.moneytracker.model.Period;
+import com.blogspot.e_kanivets.moneytracker.model.Record;
+import com.blogspot.e_kanivets.moneytracker.report.base.IExchangeRateProvider;
+import com.blogspot.e_kanivets.moneytracker.report.base.IReport;
+import com.blogspot.e_kanivets.moneytracker.report.model.CategoryRecord;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * First {@link IReport} implementation.
+ * Created on 2/25/16.
+ *
+ * @author Evgenii Kanivets
+ */
+public class Report implements IReport {
+    @SuppressWarnings("unused")
+    private static final String TAG = "Report";
+
+    private String currency;
+    private Period period;
+    private List<Record> recordList;
+    private IExchangeRateProvider rateProvider;
+
+    public Report(String currency, Period period, List<Record> recordList, IExchangeRateProvider rateProvider) {
+        if (currency == null || period == null || recordList == null || rateProvider == null)
+            throw new NullPointerException("Params can't be null");
+
+        this.currency = currency;
+        this.period = period;
+        this.recordList = recordList;
+        this.rateProvider = rateProvider;
+    }
+
+    @NonNull
+    @Override
+    public String getCurrency() {
+        return currency;
+    }
+
+    @NonNull
+    @Override
+    public Period getPeriod() {
+        return period;
+    }
+
+    @Override
+    public double getTotal() {
+        return 0;
+    }
+
+    @Override
+    public double getTotalIncome() {
+        return 0;
+    }
+
+    @Override
+    public double getTotalExpense() {
+        return 0;
+    }
+
+    @NonNull
+    @Override
+    public List<CategoryRecord> getSummary() {
+        return new ArrayList<>();
+    }
+}

app/src/main/java/com/blogspot/e_kanivets/moneytracker/report/base/IExchangeRateProvider.java

@@ -0,0 +1,23 @@
+package com.blogspot.e_kanivets.moneytracker.report.base;
+
+import android.support.annotation.Nullable;
+
+import com.blogspot.e_kanivets.moneytracker.model.ExchangeRate;
+import com.blogspot.e_kanivets.moneytracker.model.Record;
+
+/**
+ * Interface that represents a contract of access to currency exchange rate.
+ * Created on 2/25/16.
+ *
+ * @author Evgenii Kanivets
+ */
+public interface IExchangeRateProvider {
+    /**
+     * Gives an exchange rate for given record.
+     *
+     * @param record to request an exchange rate for
+     * @return exchange rate
+     */
+    @Nullable
+    ExchangeRate getRate(@Nullable Record record);
+}

app/src/main/java/com/blogspot/e_kanivets/moneytracker/report/base/IReport.java

@@ -0,0 +1,46 @@
+package com.blogspot.e_kanivets.moneytracker.report.base;
+
+import android.support.annotation.NonNull;
+
+import com.blogspot.e_kanivets.moneytracker.model.Period;
+import com.blogspot.e_kanivets.moneytracker.report.model.CategoryRecord;
+
+import java.util.List;
+
+/**
+ * Interface that represents a contract of access to report data.
+ * Created on 2/25/16.
+ *
+ * @author Evgenii Kanivets
+ */
+public interface IReport {
+    /**
+     * @return code of report currency
+     */
+    @NonNull String getCurrency();
+
+    /**
+     * @return period of report
+     */
+    @NonNull Period getPeriod();
+
+    /**
+     * @return total sum in given currency for given period
+     */
+    double getTotal();
+
+    /**
+     * @return total of all incomes for given period
+     */
+    double getTotalIncome();
+
+    /**
+     * @return total of all expenses for given period
+     */
+    double getTotalExpense();
+
+    /**
+     * @return summary list
+     */
+    @NonNull List<CategoryRecord> getSummary();
+}

app/src/main/java/com/blogspot/e_kanivets/moneytracker/report/model/CategoryRecord.java

@@ -0,0 +1,7 @@
+package com.blogspot.e_kanivets.moneytracker.report.model;
+
+/**
+ * Created by evgenii_kanivets on 2/25/16.
+ */
+public class CategoryRecord {
+}