1   /**
2    * Investor, the open-source investment library
3    *
4    * (C) Copyright 2008, by individual contributors as indicated by the @author tag.
5    *
6    * This library is free software; you can redistribute it and/or modify it
7    * under the terms of the GNU Lesser General Public License as
8    * published by the Free Software Foundation; either version 2.1 of
9    * the License, or (at your option) any later version.
10   *
11   * This software is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this software; if not, write to the Free
18   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
20   */
21  package com.nickokiss.investor.fin.element;
22  
23  import java.math.BigDecimal;
24  import java.util.Comparator;
25  
26  import com.nickokiss.investor.calc.CashFlowStreamCalc;
27  
28  /**
29   * Use in case of one-time opportunity investment
30   * 
31   * @author Tomasz Koscinski <tomasz.koscinski@nickokiss.com>
32   */
33  public class CashFlowPVComparator implements Comparator<CashFlowStream> {
34  
35    private BigDecimal nominalInterestRate;
36    private BigDecimal periodsPerYear;
37    private Integer scale; 
38    
39    @Override
40    public int compare(CashFlowStream cfs1, CashFlowStream cfs2) {
41      CashFlowStreamCalc calc = new CashFlowStreamCalc();
42      BigDecimal presentValue1 = calc.getStartValue(cfs1, nominalInterestRate, periodsPerYear);
43      BigDecimal presentValue2 = calc.getStartValue(cfs2, nominalInterestRate, periodsPerYear);
44      if (scale != null) {
45        presentValue1 = presentValue1.setScale(scale, BigDecimal.ROUND_HALF_UP);
46        presentValue2 = presentValue2.setScale(scale, BigDecimal.ROUND_HALF_UP);
47      }
48      return presentValue1.compareTo(presentValue2);
49    }
50  
51    public BigDecimal getNominalInterestRate() {
52      return nominalInterestRate;
53    }
54  
55    public void setNominalInterestRate(BigDecimal nominalInterestRate) {
56      this.nominalInterestRate = nominalInterestRate;
57    }
58  
59    public BigDecimal getPeriodsPerYear() {
60      return periodsPerYear;
61    }
62  
63    public void setPeriodsPerYear(BigDecimal periodsPerYear) {
64      this.periodsPerYear = periodsPerYear;
65    }
66  
67    public CashFlowPVComparator(BigDecimal nominalInterestRate, BigDecimal periodsPerYear) {
68      super();
69      this.nominalInterestRate = nominalInterestRate;
70      this.periodsPerYear = periodsPerYear;
71    }
72  
73    public Integer getScale() {
74      return scale;
75    }
76  
77    public void setScale(Integer scale) {
78      this.scale = scale;
79    }
80  
81  
82  }