Challenge receipt update - estimation and actual listed in same table

Author: hohosky

src/java/main/com/topcoder/direct/services/view/dto/contest/ContestReceiptDTO.java

@@ -4,9 +4,15 @@
 package com.topcoder.direct.services.view.dto.contest;
 
 import com.topcoder.direct.services.view.dto.cost.CostDTO;
+import com.topcoder.management.project.Prize;
 
 import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * <p>A DTO providing the complete details on a contest receipt.</p>
@@ -35,8 +41,17 @@
  * </ul>
  * </p>
  *
+ * <p>
+ * Version 1.5 ([Direct] - challenge receipt page update)
+ * <ul>
+ *     <li>Added {@link #getWinnerEntries()}</li>
+ *     <li>Added {@link #getCheckpointWinnerEntries()}</li>
+ *     <li>Added {@link #getNonWinnerEntries()}</li>
+ * </ul>
+ * </p>
+ *
  * @author flexme, GreatKevin, Veve
- * @version 1.4
+ * @version 1.5
  */
 public class ContestReceiptDTO implements Serializable {
     /**
@@ -500,6 +515,133 @@ public void setEntries(List<ContestReceiptEntry> entries) {
         this.entries = entries;
     }
 
+    /**
+     * Gets the winner entries.
+     *
+     * @return the list of winner entries.
+     * @since 1.5
+     */
+    public List<ContestReceiptEntry> getWinnerEntries() {
+        List<ContestReceiptEntry> winnerEntries = new ArrayList<ContestReceiptEntry>();
+
+        for (ContestReceiptEntry e : this.getEntries()) {
+
+            if (e.getPaymentType().equalsIgnoreCase("winner")) {
+                winnerEntries.add(e);
+            }
+        }
+
+        Collections.sort(winnerEntries, new Comparator<ContestReceiptEntry>() {
+            public int compare(ContestReceiptEntry o1, ContestReceiptEntry o2) {
+                return Double.compare(o2.getPaymentAmount(), o1.getPaymentAmount());
+            }
+        });
+
+        // get the main winner prizes
+        List<Prize> prizes = getEstimation().getMainPrizes();
+
+        int prizeRank = 1;
+
+        int maxPrizePlace = -1;
+
+        for (ContestReceiptEntry e : winnerEntries) {
+            for (Prize p : prizes) {
+
+                if (p.getPlace() > maxPrizePlace) {
+                    maxPrizePlace = p.getPlace();
+                }
+
+                if (p.getPlace() == prizeRank ) {
+                    e.setEstimatedAmount(p.getPrizeAmount());
+                }
+            }
+            prizeRank++;
+        }
+
+        if (maxPrizePlace > winnerEntries.size()) {
+            for (int k = winnerEntries.size(); k < maxPrizePlace; ++k) {
+                ContestReceiptEntry extraEntry = new ContestReceiptEntry();
+                extraEntry.setPaymentType("Winner");
+                extraEntry.setEstimatedAmount(prizes.get(k).getPrizeAmount());
+                winnerEntries.add(extraEntry);
+            }
+        }
+
+        return winnerEntries;
+    }
+
+    /**
+     * Gets the checkpoint winner entries.
+     *
+     * @return the checkpoint winner entries.
+     * @since 1.5
+     */
+    public List<ContestReceiptEntry> getCheckpointWinnerEntries() {
+        List<ContestReceiptEntry> checkpointWinnerEntries = new ArrayList<ContestReceiptEntry>();
+
+        // get the checkpoint prize
+        Prize checkpointPrize = this.getEstimation().getCheckpointPrize();
+
+        if (checkpointPrize == null) {
+            return checkpointWinnerEntries;
+        }
+
+        for (ContestReceiptEntry e : this.getEntries()) {
+            if(e.getPaymentType().equalsIgnoreCase("checkpoint winner")) {
+                checkpointWinnerEntries.add(e);
+            }
+        }
+
+        Collections.sort(checkpointWinnerEntries, new Comparator<ContestReceiptEntry>() {
+            public int compare(ContestReceiptEntry o1, ContestReceiptEntry o2) {
+                return Double.compare(o2.getPaymentAmount(), o1.getPaymentAmount());
+            }
+        });
+
+        for (ContestReceiptEntry e : checkpointWinnerEntries) {
+            e.setEstimatedAmount(checkpointPrize.getPrizeAmount());
+        }
+
+        if (checkpointPrize.getNumberOfSubmissions() > checkpointWinnerEntries.size()) {
+            for (int k = checkpointWinnerEntries.size(); k < checkpointPrize.getNumberOfSubmissions(); ++k) {
+                ContestReceiptEntry extraEntry = new ContestReceiptEntry();
+                extraEntry.setPaymentType("Checkpoint Winner");
+                extraEntry.setEstimatedAmount(checkpointPrize.getPrizeAmount());
+                checkpointWinnerEntries.add(extraEntry);
+            }
+        }
+
+        return checkpointWinnerEntries;
+    }
+
+    /**
+     * Gets the nonWinner (checkpoint winner) entries.
+     *
+     * @return the list of nonWinner (checkpint winner) entries.
+     * @since 1.5
+     */
+    public Map<String, ContestReceiptEntry> getNonWinnerEntries() {
+        // map which is used to aggregate the payment amount of the same payment type
+        Map<String, ContestReceiptEntry> entriesMap = new HashMap<String, ContestReceiptEntry>();
+
+        for (ContestReceiptEntry e : this.getEntries()) {
+            if (!(e.getPaymentType().equalsIgnoreCase("winner")
+                    || e.getPaymentType().equalsIgnoreCase("checkpoint winner"))) {
+                if (entriesMap.containsKey(e.getPaymentType())) {
+                    // exists, sum up the payment amount
+                    ContestReceiptEntry existingEntry = entriesMap.get(e.getPaymentType());
+                    existingEntry.setPaymentAmount(existingEntry.getPaymentAmount() + e.getPaymentAmount());
+                } else {
+                    // no exist, put into map
+                    entriesMap.put(e.getPaymentType(), new ContestReceiptEntry(e));
+                }
+            }
+        }
+
+        return entriesMap;
+    }
+
+
     /**
      * Gets the estimation cost.
      *

src/java/main/com/topcoder/direct/services/view/dto/contest/ContestReceiptEntry.java

@@ -1,13 +1,23 @@
 /*
- * Copyright (C) 2012 TopCoder Inc., All Rights Reserved.
+ * Copyright (C) 2012 - 2014 TopCoder Inc., All Rights Reserved.
  */
 package com.topcoder.direct.services.view.dto.contest;
 
 /**
  * Represents a record entry in the contest receipt
  *
- * @author GreatKevin
- * @version 1.0
+ * <p>
+ * Version 1.1 ([Direct] - challenge receipt page update)
+ * <ul>
+ *     <li>Added {@link #paymentTypeId} and its getter and setter</li>
+ *     <li>Added {@link #estimatedAmount} and its getter and setter</li>
+ *     <li>Added default constructor {@link #ContestReceiptEntry()}</li>
+ *     <li>Added copy constructor {@link #ContestReceiptEntry(ContestReceiptEntry)}</li>
+ * </ul>
+ * </p>
+ *
+ * @author GreatKevin, Veve
+ * @version 1.1
  */
 public class ContestReceiptEntry {
 
@@ -21,6 +31,40 @@ public class ContestReceiptEntry {
      */
     private double paymentAmount;
 
+    /**
+     * The payment type id.
+     * @since 1.1
+     */
+    private long paymentTypeId;
+
+    /**
+     * The estimation cost amount of this payment type.
+     * @since 1.1
+     */
+    private double estimatedAmount;
+
+    /**
+     * The default constructor.
+     *
+     * @since 1.1
+     */
+    public ContestReceiptEntry() {
+
+    }
+
+    /**
+     * The copy constructor.
+     *
+     * @param entry the entry to copy.
+     * @since 1.1
+     */
+    public ContestReceiptEntry(ContestReceiptEntry entry) {
+        this.paymentType = entry.getPaymentType();
+        this.paymentAmount = entry.getPaymentAmount();
+        this.paymentTypeId = entry.getPaymentTypeId();
+        this.estimatedAmount = entry.getEstimatedAmount();
+    }
+
     /**
      * Gets the payment type.
      *
@@ -56,4 +100,44 @@ public double getPaymentAmount() {
     public void setPaymentAmount(double paymentAmount) {
         this.paymentAmount = paymentAmount;
     }
+
+    /**
+     * Gets the payment type id.
+     *
+     * @return the payment type id.
+     * @since 1.1
+     */
+    public long getPaymentTypeId() {
+        return paymentTypeId;
+    }
+
+    /**
+     * Sets the payment type id.
+     *
+     * @param paymentTypeId the payment type id.
+     * @since 1.1
+     */
+    public void setPaymentTypeId(long paymentTypeId) {
+        this.paymentTypeId = paymentTypeId;
+    }
+
+    /**
+     * Gets the estimated amount.
+     *
+     * @return the estimated amount.
+     * @since 1.1
+     */
+    public double getEstimatedAmount() {
+        return estimatedAmount;
+    }
+
+    /**
+     * Sets the estimated amount.
+     *
+     * @param estimatedAmount the estimated amount.
+     * @since 1.1
+     */
+    public void setEstimatedAmount(double estimatedAmount) {
+        this.estimatedAmount = estimatedAmount;
+    }
 }