MoneyWiseXAnalysisTaxBasisBucket.java
/*
* MoneyWise: Finance Application
* Copyright 2012-2026. Tony Washer
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDate;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDateRange;
import io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimal;
import io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney;
import io.github.tonywasher.joceanus.oceanus.format.OceanusDataFormatter;
import io.github.tonywasher.joceanus.metis.data.MetisDataFieldValue;
import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataFieldId;
import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataList;
import io.github.tonywasher.joceanus.metis.field.MetisFieldItem;
import io.github.tonywasher.joceanus.metis.field.MetisFieldItem.MetisFieldTableItem;
import io.github.tonywasher.joceanus.metis.field.MetisFieldSet;
import io.github.tonywasher.joceanus.metis.list.MetisListIndexed;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.base.MoneyWiseXAnalysisEvent;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.base.MoneyWiseXAnalysisHistory;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysisInterfaces.MoneyWiseXAnalysisBucketRegister;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysisTaxBasisAccountBucket.MoneyWiseXAnalysisTaxBasisAccountBucketList;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.values.MoneyWiseXAnalysisTaxBasisAttr;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.values.MoneyWiseXAnalysisTaxBasisValues;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseAssetType;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransAsset;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransaction;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseCurrency;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseStaticDataType;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxBasis;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxBasis.MoneyWiseTaxBasisList;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxClass;
import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseChargeableGainSlice.MoneyWiseChargeableGainSliceList;
import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxSource;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusEditSet;
import java.util.Comparator;
import java.util.Currency;
import java.util.Iterator;
import java.util.List;
/**
* The TaxBasis Bucket class.
*/
public class MoneyWiseXAnalysisTaxBasisBucket
implements MetisFieldTableItem, MoneyWiseXAnalysisBucketRegister {
/**
* Local Report fields.
*/
private static final MetisFieldSet<MoneyWiseXAnalysisTaxBasisBucket> FIELD_DEFS = MetisFieldSet.newFieldSet(MoneyWiseXAnalysisTaxBasisBucket.class);
/*
* Declare Fields.
*/
static {
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.ANALYSIS_NAME, MoneyWiseXAnalysisTaxBasisBucket::getAnalysis);
FIELD_DEFS.declareLocalField(MoneyWiseStaticDataType.TAXBASIS, MoneyWiseXAnalysisTaxBasisBucket::getTaxBasis);
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.BUCKET_BASEVALUES, MoneyWiseXAnalysisTaxBasisBucket::getBaseValues);
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.BUCKET_HISTORY, MoneyWiseXAnalysisTaxBasisBucket::getHistoryMap);
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.TAXBASIS_ACCOUNTLIST, MoneyWiseXAnalysisTaxBasisBucket::getAccounts);
FIELD_DEFS.declareLocalFieldsForEnum(MoneyWiseXAnalysisTaxBasisAttr.class, MoneyWiseXAnalysisTaxBasisBucket::getAttributeValue);
}
/**
* Totals bucket name.
*/
private static final MetisDataFieldId NAME_TOTALS = MoneyWiseXAnalysisBucketResource.ANALYSIS_TOTALS;
/**
* The analysis.
*/
private final MoneyWiseXAnalysis theAnalysis;
/**
* Tax Basis.
*/
private final MoneyWiseTaxBasis theTaxBasis;
/**
* Values.
*/
private final MoneyWiseXAnalysisTaxBasisValues theValues;
/**
* The base values.
*/
private final MoneyWiseXAnalysisTaxBasisValues theBaseValues;
/**
* History Map.
*/
private final MoneyWiseXAnalysisHistory<MoneyWiseXAnalysisTaxBasisValues, MoneyWiseXAnalysisTaxBasisAttr> theHistory;
/**
* Do we have accounts?
*/
private final boolean hasAccounts;
/**
* Are we an expense bucket?
*/
private final boolean isExpense;
/**
* AccountBucketList.
*/
private final MoneyWiseXAnalysisTaxBasisAccountBucketList theAccounts;
/**
* Constructor.
*
* @param pAnalysis the analysis
* @param pTaxBasis the basis
*/
protected MoneyWiseXAnalysisTaxBasisBucket(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseTaxBasis pTaxBasis) {
/* Store the parameters */
theTaxBasis = pTaxBasis;
theAnalysis = pAnalysis;
isExpense = theTaxBasis != null
&& theTaxBasis.getTaxClass().isExpense();
/* Create the history map */
final MoneyWiseCurrency myDefault = theAnalysis.getCurrency();
final Currency myCurrency = myDefault == null
? MoneyWiseXAnalysisAccountBucket.DEFAULT_CURRENCY
: myDefault.getCurrency();
final MoneyWiseXAnalysisTaxBasisValues myValues = new MoneyWiseXAnalysisTaxBasisValues(myCurrency);
theHistory = new MoneyWiseXAnalysisHistory<>(myValues);
/* Create the account list */
hasAccounts = theTaxBasis != null
&& !(this instanceof MoneyWiseXAnalysisTaxBasisAccountBucket)
&& theTaxBasis.getTaxClass().analyseAccounts();
theAccounts = hasAccounts
? new MoneyWiseXAnalysisTaxBasisAccountBucketList(theAnalysis, this)
: null;
/* Access the key value maps */
theValues = theHistory.getValues();
theBaseValues = theHistory.getBaseValues();
}
/**
* Constructor.
*
* @param pAnalysis the analysis
* @param pBase the underlying bucket
* @param pDate the date for the bucket
*/
protected MoneyWiseXAnalysisTaxBasisBucket(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseXAnalysisTaxBasisBucket pBase,
final OceanusDate pDate) {
/* Copy details from base */
theTaxBasis = pBase.getTaxBasis();
theAnalysis = pAnalysis;
isExpense = pBase.isExpense();
/* Access the relevant history */
theHistory = new MoneyWiseXAnalysisHistory<>(pBase.getHistoryMap(), pDate);
/* Create the account list */
hasAccounts = pBase.hasAccounts();
theAccounts = hasAccounts
? new MoneyWiseXAnalysisTaxBasisAccountBucketList(theAnalysis, this, pBase.getAccounts(), pDate)
: null;
/* Access the key value maps */
theValues = theHistory.getValues();
theBaseValues = theHistory.getBaseValues();
}
/**
* Constructor.
*
* @param pAnalysis the analysis
* @param pBase the underlying bucket
* @param pRange the range for the bucket
*/
protected MoneyWiseXAnalysisTaxBasisBucket(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseXAnalysisTaxBasisBucket pBase,
final OceanusDateRange pRange) {
/* Copy details from base */
theTaxBasis = pBase.getTaxBasis();
theAnalysis = pAnalysis;
isExpense = pBase.isExpense();
/* Access the relevant history */
theHistory = new MoneyWiseXAnalysisHistory<>(pBase.getHistoryMap(), pRange);
/* Create the account list */
hasAccounts = pBase.hasAccounts();
theAccounts = hasAccounts
? new MoneyWiseXAnalysisTaxBasisAccountBucketList(theAnalysis, this, pBase.getAccounts(), pRange)
: null;
/* Access the key value maps */
theValues = theHistory.getValues();
theBaseValues = theHistory.getBaseValues();
}
@Override
public MetisFieldSet<? extends MoneyWiseXAnalysisTaxBasisBucket> getDataFieldSet() {
return FIELD_DEFS;
}
@Override
public String formatObject(final OceanusDataFormatter pFormatter) {
return toString();
}
@Override
public String toString() {
return getName() + " " + theValues;
}
@Override
public Integer getIndexedId() {
return theTaxBasis.getIndexedId();
}
@Override
public Long getBucketId() {
return MoneyWiseAssetType.createExternalId(MoneyWiseAssetType.TAXBASIS, getIndexedId());
}
/**
* Obtain name.
*
* @return the name
*/
public String getName() {
return theTaxBasis == null
? NAME_TOTALS.getId()
: theTaxBasis.getName();
}
/**
* Obtain tax basis.
*
* @return the basis
*/
public MoneyWiseTaxBasis getTaxBasis() {
return theTaxBasis;
}
/**
* Do we have accounts.
*
* @return true/false
*/
public boolean hasAccounts() {
return hasAccounts;
}
/**
* Is this an expense bucket.
*
* @return true/false
*/
public boolean isExpense() {
return isExpense;
}
/**
* Obtain account list.
*
* @return the account list
*/
private MoneyWiseXAnalysisTaxBasisAccountBucketList getAccounts() {
return theAccounts;
}
/**
* Obtain account list iterator.
*
* @return the iterator
*/
public Iterator<MoneyWiseXAnalysisTaxBasisAccountBucket> accountIterator() {
return hasAccounts
? theAccounts.iterator()
: null;
}
/**
* find an account bucket.
*
* @param pAccount the account
* @return the bucket
*/
public MoneyWiseXAnalysisTaxBasisAccountBucket findAccountBucket(final MoneyWiseTransAsset pAccount) {
return hasAccounts
? theAccounts.findBucket(pAccount)
: null;
}
/**
* Is this bucket idle?
*
* @return true/false
*/
public boolean isIdle() {
return theHistory.isIdle();
}
/**
* Obtain the value map.
*
* @return the value map
*/
public MoneyWiseXAnalysisTaxBasisValues getValues() {
return theValues;
}
/**
* Obtain the value for a particular attribute.
*
* @param pAttr the attribute
* @return the value
*/
public OceanusMoney getMoneyValue(final MoneyWiseXAnalysisTaxBasisAttr pAttr) {
return theValues.getMoneyValue(pAttr);
}
/**
* Obtain the base value map.
*
* @return the base value map
*/
public MoneyWiseXAnalysisTaxBasisValues getBaseValues() {
return theBaseValues;
}
/**
* Obtain values for event.
*
* @param pEvent the event
* @return the values (or null)
*/
public MoneyWiseXAnalysisTaxBasisValues getValuesForEvent(final MoneyWiseXAnalysisEvent pEvent) {
/* Obtain values for event */
return theHistory.getValuesForEvent(pEvent);
}
/**
* Obtain previous values for event.
*
* @param pEvent the event
* @return the values (or null)
*/
public MoneyWiseXAnalysisTaxBasisValues getPreviousValuesForEvent(final MoneyWiseXAnalysisEvent pEvent) {
return theHistory.getPreviousValuesForEvent(pEvent);
}
/**
* Obtain delta for event.
*
* @param pEvent the event
* @param pAttr the attribute
* @return the delta (or null)
*/
public OceanusDecimal getDeltaForEvent(final MoneyWiseXAnalysisEvent pEvent,
final MoneyWiseXAnalysisTaxBasisAttr pAttr) {
/* Obtain delta for event */
return theHistory.getDeltaValue(pEvent, pAttr);
}
/**
* Obtain the history map.
*
* @return the history map
*/
private MoneyWiseXAnalysisHistory<MoneyWiseXAnalysisTaxBasisValues, MoneyWiseXAnalysisTaxBasisAttr> getHistoryMap() {
return theHistory;
}
/**
* Obtain the analysis.
*
* @return the analysis
*/
protected MoneyWiseXAnalysis getAnalysis() {
return theAnalysis;
}
/**
* Obtain date range.
*
* @return the range
*/
public OceanusDateRange getDateRange() {
return theAnalysis.getDateRange();
}
/**
* Set Attribute.
*
* @param pAttr the attribute
* @param pValue the value of the attribute
*/
protected void setValue(final MoneyWiseXAnalysisTaxBasisAttr pAttr,
final OceanusMoney pValue) {
/* Set the value into the list */
theValues.setValue(pAttr, pValue);
}
/**
* Get an attribute value.
*
* @param pAttr the attribute
* @return the value to set
*/
private Object getAttributeValue(final MoneyWiseXAnalysisTaxBasisAttr pAttr) {
/* Access value of object */
final Object myValue = getValue(pAttr);
/* Return the value */
return myValue != null
? myValue
: MetisDataFieldValue.SKIP;
}
/**
* Obtain an attribute value.
*
* @param pAttr the attribute
* @return the value of the attribute or null
*/
private Object getValue(final MoneyWiseXAnalysisTaxBasisAttr pAttr) {
/* Obtain the attribute */
return theValues.getValue(pAttr);
}
/**
* Adjust Gross and Nett values by amount.
*
* @param pAmount the amount
*/
public void adjustGrossAndNett(final OceanusMoney pAmount) {
adjustGrossAndNett(null, pAmount);
}
/**
* Adjust Gross value by amount.
*
* @param pAmount the amount
*/
public void adjustGross(final OceanusMoney pAmount) {
adjustGross(null, pAmount);
}
/**
* Adjust Gross and Tax values by amount.
*
* @param pAmount the amount
*/
public void adjustGrossAndTax(final OceanusMoney pAmount) {
adjustGrossAndTax(null, pAmount);
}
/**
* Adjust Gross and Nett values by amount.
*
* @param pAccount the relevant account
* @param pAmount the amount
* @return the adjusted taxBasisAccountBucket (or null)
*/
public MoneyWiseXAnalysisTaxBasisAccountBucket adjustGrossAndNett(final MoneyWiseTransAsset pAccount,
final OceanusMoney pAmount) {
return adjustValue(pAccount, pAmount, MoneyWiseXTaxBasisAdjust.STANDARD);
}
/**
* Adjust Gross value by amount.
*
* @param pAccount the relevant account
* @param pAmount the amount
* @return the adjusted taxBasisAccountBucket (or null)
*/
public MoneyWiseXAnalysisTaxBasisAccountBucket adjustGross(final MoneyWiseTransAsset pAccount,
final OceanusMoney pAmount) {
return adjustValue(pAccount, pAmount, MoneyWiseXTaxBasisAdjust.GROSS);
}
/**
* Adjust Gross and Tax values by amount.
*
* @param pAccount the relevant account
* @param pAmount the amount
* @return the adjusted taxBasisAccountBucket (or null)
*/
public MoneyWiseXAnalysisTaxBasisAccountBucket adjustGrossAndTax(final MoneyWiseTransAsset pAccount,
final OceanusMoney pAmount) {
return adjustValue(pAccount, pAmount, MoneyWiseXTaxBasisAdjust.TAXCREDIT);
}
/**
* Adjust value.
*
* @param pAccount the relevant account
* @param pValue the value
* @param pAdjust adjustment control
* @return the adjusted taxBasisAccountBucket (or null)
*/
MoneyWiseXAnalysisTaxBasisAccountBucket adjustValue(final MoneyWiseTransAsset pAccount,
final OceanusMoney pValue,
final MoneyWiseXTaxBasisAdjust pAdjust) {
/* Access the existing value */
OceanusMoney myGross = theValues.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.GROSS);
myGross = new OceanusMoney(myGross);
/* Subtract or add the value depending as to whether we are an expense bucket */
if (isExpense) {
myGross.subtractAmount(pValue);
} else {
myGross.addAmount(pValue);
}
/* Record the new value */
setValue(MoneyWiseXAnalysisTaxBasisAttr.GROSS, myGross);
/* If we are adjusting Nett */
if (pAdjust.adjustNett()) {
/* Access the existing value */
OceanusMoney myNett = theValues.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.NETT);
myNett = new OceanusMoney(myNett);
/* Subtract or add the value if we are an expense/income bucket */
if (isExpense) {
myNett.subtractAmount(pValue);
} else {
myNett.addAmount(pValue);
}
/* Record the new value */
setValue(MoneyWiseXAnalysisTaxBasisAttr.NETT, myNett);
}
/* If we are adjusting TaxCredit */
if (pAdjust.adjustTaxCredit()) {
/* Access the existing value */
OceanusMoney myTax = theValues.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.TAXCREDIT);
myTax = new OceanusMoney(myTax);
/* Subtract or add the value if we are an expense/income bucket */
if (isExpense) {
myTax.subtractAmount(pValue);
} else {
myTax.addAmount(pValue);
}
/* Record the new value */
setValue(MoneyWiseXAnalysisTaxBasisAttr.TAXCREDIT, myTax);
}
/* If we have accounts and are passed an account, adjust value for account and return the bucket */
return hasAccounts && pAccount != null
? theAccounts.adjustValue(pAccount, pValue, pAdjust)
: null;
}
@Override
public void registerEvent(final MoneyWiseXAnalysisEvent pEvent) {
/* Register the transaction in the history */
theHistory.registerEvent(pEvent, theValues);
}
/**
* Add values.
*
* @param pBucket tax category bucket
*/
protected void addValues(final MoneyWiseXAnalysisTaxBasisBucket pBucket) {
/* Add the values */
OceanusMoney myAmount = theValues.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.GROSS);
myAmount.addAmount(pBucket.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.GROSS));
myAmount = theValues.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.NETT);
myAmount.addAmount(pBucket.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.NETT));
}
/**
* Adjust to base.
*/
protected void adjustToBase() {
/* Adjust to base values */
theValues.adjustToBaseValues(theBaseValues);
theBaseValues.resetBaseValues();
}
/**
* Value adjust Modes.
*/
public enum MoneyWiseXTaxBasisAdjust {
/**
* Adjust both Gross and Nett.
*/
STANDARD,
/**
* Adjust Gross only.
*/
GROSS,
/**
* Adjust Gross and Tax.
*/
TAXCREDIT;
/**
* should we adjust Nett?
*
* @return true/false
*/
private boolean adjustNett() {
return this == STANDARD;
}
/**
* should we adjust TaxCredit?
*
* @return true/false
*/
private boolean adjustTaxCredit() {
return this == TAXCREDIT;
}
}
/**
* TaxBasisBucketList class.
*/
public static class MoneyWiseXAnalysisTaxBasisBucketList
implements MetisFieldItem, MoneyWiseTaxSource, MetisDataList<MoneyWiseXAnalysisTaxBasisBucket> {
/**
* Local Report fields.
*/
private static final MetisFieldSet<MoneyWiseXAnalysisTaxBasisBucketList> FIELD_DEFS = MetisFieldSet.newFieldSet(MoneyWiseXAnalysisTaxBasisBucketList.class);
/*
* Declare Fields.
*/
static {
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.ANALYSIS_NAME, MoneyWiseXAnalysisTaxBasisBucketList::getAnalysis);
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.ANALYSIS_CHARGES, MoneyWiseXAnalysisTaxBasisBucketList::getGainSlices);
FIELD_DEFS.declareLocalField(MoneyWiseXAnalysisBucketResource.ANALYSIS_TOTALS, MoneyWiseXAnalysisTaxBasisBucketList::getTotals);
}
/**
* The analysis.
*/
private final MoneyWiseXAnalysis theAnalysis;
/**
* The list.
*/
private final MetisListIndexed<MoneyWiseXAnalysisTaxBasisBucket> theList;
/**
* The editSet.
*/
private final PrometheusEditSet theEditSet;
/**
* The chargeableGains.
*/
private final MoneyWiseChargeableGainSliceList theCharges;
/**
* The tax basis.
*/
private final MoneyWiseXAnalysisTaxBasisBucket theTotals;
/**
* Construct a top-level List.
*
* @param pAnalysis the analysis
* @param pGains the new Gains list
*/
private MoneyWiseXAnalysisTaxBasisBucketList(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseChargeableGainSliceList pGains) {
theAnalysis = pAnalysis;
theEditSet = theAnalysis.getEditSet();
theCharges = pGains;
theTotals = allocateTotalsBucket();
theList = new MetisListIndexed<>();
theList.setComparator(Comparator.comparing(MoneyWiseXAnalysisTaxBasisBucket::getTaxBasis));
}
/**
* Construct a top-level List.
*
* @param pAnalysis the analysis
*/
protected MoneyWiseXAnalysisTaxBasisBucketList(final MoneyWiseXAnalysis pAnalysis) {
this(pAnalysis, new MoneyWiseChargeableGainSliceList());
}
/**
* Construct a dated List.
*
* @param pAnalysis the analysis
* @param pBase the base list
* @param pDate the Date
*/
protected MoneyWiseXAnalysisTaxBasisBucketList(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseXAnalysisTaxBasisBucketList pBase,
final OceanusDate pDate) {
/* Initialise class */
this(pAnalysis, new MoneyWiseChargeableGainSliceList(pBase.getGainSlices(), pAnalysis.getDateRange()));
/* Loop through the buckets */
final Iterator<MoneyWiseXAnalysisTaxBasisBucket> myIterator = pBase.iterator();
while (myIterator.hasNext()) {
final MoneyWiseXAnalysisTaxBasisBucket myCurr = myIterator.next();
/* Access the bucket for this date */
final MoneyWiseXAnalysisTaxBasisBucket myBucket = new MoneyWiseXAnalysisTaxBasisBucket(pAnalysis, myCurr, pDate);
/* If the bucket is non-idle */
if (!myBucket.isIdle()) {
/* Calculate the delta and add to the list */
theList.add(myBucket);
}
}
}
/**
* Construct a ranged List.
*
* @param pAnalysis the analysis
* @param pBase the base list
* @param pRange the Date Range
*/
protected MoneyWiseXAnalysisTaxBasisBucketList(final MoneyWiseXAnalysis pAnalysis,
final MoneyWiseXAnalysisTaxBasisBucketList pBase,
final OceanusDateRange pRange) {
/* Initialise class */
this(pAnalysis, new MoneyWiseChargeableGainSliceList(pBase.getGainSlices(), pAnalysis.getDateRange()));
/* Loop through the buckets */
final Iterator<MoneyWiseXAnalysisTaxBasisBucket> myIterator = pBase.iterator();
while (myIterator.hasNext()) {
final MoneyWiseXAnalysisTaxBasisBucket myCurr = myIterator.next();
/* Access the bucket for this range */
final MoneyWiseXAnalysisTaxBasisBucket myBucket = new MoneyWiseXAnalysisTaxBasisBucket(pAnalysis, myCurr, pRange);
/* If the bucket is non-idle */
if (!myBucket.isIdle()) {
/* Adjust to the base */
myBucket.adjustToBase();
theList.add(myBucket);
}
}
}
@Override
public MetisFieldSet<MoneyWiseXAnalysisTaxBasisBucketList> getDataFieldSet() {
return FIELD_DEFS;
}
@Override
public List<MoneyWiseXAnalysisTaxBasisBucket> getUnderlyingList() {
return theList.getUnderlyingList();
}
@Override
public String formatObject(final OceanusDataFormatter pFormatter) {
return getDataFieldSet().getName();
}
/**
* Obtain the analysis.
*
* @return the analysis
*/
protected MoneyWiseXAnalysis getAnalysis() {
return theAnalysis;
}
/**
* Obtain item by id.
*
* @param pId the id to lookup
* @return the item (or null if not present)
*/
public MoneyWiseXAnalysisTaxBasisBucket findItemById(final Integer pId) {
/* Return results */
return theList.getItemById(pId);
}
@Override
public MoneyWiseChargeableGainSliceList getGainSlices() {
return theCharges;
}
/**
* Obtain the Totals.
*
* @return the totals bucket
*/
public MoneyWiseXAnalysisTaxBasisBucket getTotals() {
return theTotals;
}
/**
* Allocate the Totals EventCategoryBucket.
*
* @return the bucket
*/
private MoneyWiseXAnalysisTaxBasisBucket allocateTotalsBucket() {
/* Obtain the totals category */
return new MoneyWiseXAnalysisTaxBasisBucket(theAnalysis, null);
}
/**
* Obtain the TaxBasisBucket for a given taxBasis.
*
* @param pClass the taxBasis
* @return the bucket
*/
public MoneyWiseXAnalysisTaxBasisBucket getBucket(final MoneyWiseTaxClass pClass) {
/* Locate the bucket in the list */
final MoneyWiseTaxBasis myBasis = theEditSet.getDataList(MoneyWiseStaticDataType.TAXBASIS, MoneyWiseTaxBasisList.class).findItemByClass(pClass);
MoneyWiseXAnalysisTaxBasisBucket myItem = findItemById(myBasis.getIndexedId());
/* If the item does not yet exist */
if (myItem == null) {
/* Create the new bucket */
myItem = new MoneyWiseXAnalysisTaxBasisBucket(theAnalysis, myBasis);
/* Add to the list */
theList.add(myItem);
}
/* Return the bucket */
return myItem;
}
/**
* Obtain the matching BasisBucket.
*
* @param pTaxBasis the taxBasis
* @return the matching bucket
*/
public MoneyWiseXAnalysisTaxBasisBucket getMatchingBasis(final MoneyWiseXAnalysisTaxBasisBucket pTaxBasis) {
/* Access the matching taxBasis bucket */
MoneyWiseXAnalysisTaxBasisBucket myBasis = findItemById(pTaxBasis.getTaxBasis().getIndexedId());
if (myBasis == null) {
myBasis = new MoneyWiseXAnalysisTaxBasisBucket(theAnalysis, pTaxBasis.getTaxBasis());
}
/* If we are matching a TaxBasisAccount Bucket */
if (pTaxBasis instanceof MoneyWiseXAnalysisTaxBasisAccountBucket myBucket) {
/* Look up the asset bucket */
final MoneyWiseTransAsset myAsset = myBucket.getAccount();
MoneyWiseXAnalysisTaxBasisAccountBucket myAccountBucket = myBasis.findAccountBucket(myAsset);
/* If there is no such bucket in the analysis */
if (myAccountBucket == null) {
/* Allocate an orphan bucket */
myAccountBucket = new MoneyWiseXAnalysisTaxBasisAccountBucket(theAnalysis, myBasis, myAsset);
}
/* Set bucket as the account bucket */
myBasis = myAccountBucket;
}
/* Return the basis */
return myBasis;
}
/**
* Obtain the default BasisBucket.
*
* @return the default bucket
*/
public MoneyWiseXAnalysisTaxBasisBucket getDefaultBasis() {
/* Return the first basis in the list if it exists */
return isEmpty()
? null
: theList.getUnderlyingList().get(0);
}
/**
* record ChargeableGain.
*
* @param pTrans the transaction
* @param pGain the gain
* @param pSlice the slice
* @param pYears the years
*/
public void recordChargeableGain(final MoneyWiseTransaction pTrans,
final OceanusMoney pGain,
final OceanusMoney pSlice,
final Integer pYears) {
/* record the chargeable gain */
theCharges.addTransaction(pTrans, pGain, pSlice, pYears);
}
/**
* produce Totals.
*/
public void produceTotals() {
/* Loop through the buckets */
final Iterator<MoneyWiseXAnalysisTaxBasisBucket> myIterator = iterator();
while (myIterator.hasNext()) {
final MoneyWiseXAnalysisTaxBasisBucket myBucket = myIterator.next();
/* Remove idle items */
if (myBucket.isIdle()) {
myIterator.remove();
continue;
}
/* Sort the accounts */
if (myBucket.hasAccounts()) {
myBucket.getAccounts().sortBuckets();
}
/* Adjust the Total Profit buckets */
theTotals.addValues(myBucket);
}
/* Sort the bases */
theList.sortList();
}
@Override
public OceanusMoney getAmountForTaxBasis(final MoneyWiseTaxClass pBasis) {
/* Access the bucket */
final MoneyWiseXAnalysisTaxBasisBucket myItem = findItemById(pBasis.getClassId());
/* If the bucket is not found */
if (myItem == null) {
final MoneyWiseCurrency myAssetCurrency = theAnalysis.getCurrency();
final Currency myCurrency = myAssetCurrency == null
? OceanusMoney.getDefaultCurrency()
: myAssetCurrency.getCurrency();
return new OceanusMoney(myCurrency);
}
return myItem.getMoneyValue(MoneyWiseXAnalysisTaxBasisAttr.GROSS);
}
}
}