com.tangosol.util.aggregator.BigDecimalSum Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.09
/*
 * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * https://oss.oracle.com/licenses/upl.
 */

package com.tangosol.util.aggregator;


import com.tangosol.internal.util.aggregator.BigDecimalSerializationWrapper;
import com.tangosol.util.InvocableMap;
import com.tangosol.util.ValueExtractor;

import java.math.BigDecimal;

/**
* Calculates an sum for values of any numberic type extracted from a set of
* entries in a Map in a form of a {@link java.math.BigDecimal} value.  All
* the extracted objects will be treated as {@link java.math.BigDecimal},
* {@link java.math.BigInteger} or Java double values.
* If the set of entries is empty, a null result is returned.
*
* @param   the type of the value to extract from
*
* @author gg              2006.07.18
* @author Gunnar Hillert  2022.06.01
* @since Coherence 3.2
*/
public class BigDecimalSum
        extends AbstractBigDecimalAggregator
    {
    // ----- constructors ---------------------------------------------------

    /**
    * Default constructor (necessary for the ExternalizableLite interface).
    */
    public BigDecimalSum()
        {
        super();
        }

    /**
    * Construct a BigDecimalSum aggregator.
    *
    * @param extractor  the extractor that provides a value in the form of
    *                   any Java object that is a {@link Number}
    */
    public BigDecimalSum(ValueExtractor extractor)
        {
        super(extractor);
        }

    /**
    * Construct an BigDecimalSum object.
    *
    * @param sMethod  the name of the method that returns a value in the form
    *                 of any Java object that is a {@link Number}
    */
    public BigDecimalSum(String sMethod)
        {
        super(sMethod);
        }

    // ----- StreamingAggregator methods ------------------------------------

    @Override
    public InvocableMap.StreamingAggregator supply()
        {
        BigDecimalSum bigDecimalSum = new BigDecimalSum<>(getValueExtractor());
        bigDecimalSum.setScale(this.getScale());
        bigDecimalSum.setRoundingMode(this.getRoundingMode());
        bigDecimalSum.setStripTrailingZeros(this.isStripTrailingZeros());
        bigDecimalSum.setMathContext(this.getMathContext());
        return bigDecimalSum;
        }

    @Override
    public int characteristics()
        {
        return PARALLEL | PRESENT_ONLY;
        }

    // ----- AbstractAggregator methods -------------------------------------

    /**
    * {@inheritDoc}
    */
    protected void process(Object o, boolean fFinal)
        {
        if (o != null)
            {
            BigDecimal dec;
            if (fFinal)
                {
                dec = ((BigDecimalSerializationWrapper) o).getBigDecimal();
                }
            else
                {
                dec = ensureBigDecimal((Number) o);
                }

            BigDecimal decResult = m_decResult;

            m_decResult = decResult == null ? dec : decResult.add(dec);
            m_count++;
            }
        }
    }