View Javadoc
1   /*
2    * MoneyWise: Finance Application
3    * Copyright 2012-2026. Tony Washer
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6    * use this file except in compliance with the License.  You may obtain a copy
7    * of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
14   * License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  package io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.values;
18  
19  import io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney;
20  import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.base.MoneyWiseXAnalysisValues;
21  
22  import java.util.Currency;
23  
24  /**
25   * PayeeValues class.
26   */
27  public final class MoneyWiseXAnalysisPayeeValues
28          extends MoneyWiseXAnalysisValues<MoneyWiseXAnalysisPayeeValues, MoneyWiseXAnalysisPayeeAttr> {
29      /**
30       * Constructor.
31       *
32       * @param pCurrency the reporting currency
33       */
34      public MoneyWiseXAnalysisPayeeValues(final Currency pCurrency) {
35          /* Initialise class */
36          super(MoneyWiseXAnalysisPayeeAttr.class);
37  
38          /* Initialise income/expense to zero */
39          super.setValue(MoneyWiseXAnalysisPayeeAttr.INCOME, new OceanusMoney(pCurrency));
40          super.setValue(MoneyWiseXAnalysisPayeeAttr.EXPENSE, new OceanusMoney(pCurrency));
41      }
42  
43      /**
44       * Constructor.
45       *
46       * @param pSource the source map.
47       */
48      public MoneyWiseXAnalysisPayeeValues(final MoneyWiseXAnalysisPayeeValues pSource) {
49          /* Initialise class */
50          super(pSource);
51      }
52  
53      @Override
54      protected MoneyWiseXAnalysisPayeeValues newSnapShot() {
55          return new MoneyWiseXAnalysisPayeeValues(this);
56      }
57  
58      @Override
59      public void adjustToBaseValues(final MoneyWiseXAnalysisPayeeValues pBase) {
60          /* Adjust income/expense values */
61          adjustMoneyToBase(pBase, MoneyWiseXAnalysisPayeeAttr.INCOME);
62          adjustMoneyToBase(pBase, MoneyWiseXAnalysisPayeeAttr.EXPENSE);
63          calculateDelta();
64      }
65  
66      @Override
67      public void resetBaseValues() {
68          /* Create a zero value in the correct currency */
69          OceanusMoney myValue = getMoneyValue(MoneyWiseXAnalysisPayeeAttr.INCOME);
70          myValue = new OceanusMoney(myValue);
71          myValue.setZero();
72  
73          /* Reset Income and expense values */
74          super.setValue(MoneyWiseXAnalysisPayeeAttr.INCOME, myValue);
75          super.setValue(MoneyWiseXAnalysisPayeeAttr.EXPENSE, new OceanusMoney(myValue));
76          super.setValue(MoneyWiseXAnalysisPayeeAttr.PROFIT, new OceanusMoney(myValue));
77      }
78  
79      /**
80       * Calculate delta.
81       */
82      public void calculateDelta() {
83          /* Obtain a copy of the value */
84          OceanusMoney myDelta = getMoneyValue(MoneyWiseXAnalysisPayeeAttr.INCOME);
85          myDelta = new OceanusMoney(myDelta);
86  
87          /* Subtract the expense value */
88          final OceanusMoney myExpense = getMoneyValue(MoneyWiseXAnalysisPayeeAttr.EXPENSE);
89          myDelta.subtractAmount(myExpense);
90  
91          /* Set the delta */
92          super.setValue(MoneyWiseXAnalysisPayeeAttr.PROFIT, myDelta);
93      }
94  
95      /**
96       * Are the values?
97       *
98       * @return true/false
99       */
100     public boolean isActive() {
101         final OceanusMoney myIncome = getMoneyValue(MoneyWiseXAnalysisPayeeAttr.INCOME);
102         final OceanusMoney myExpense = getMoneyValue(MoneyWiseXAnalysisPayeeAttr.EXPENSE);
103         return myIncome.isNonZero() || myExpense.isNonZero();
104     }
105 }