Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


com.tangosol.util.aggregator
Class BigDecimalAverage

java.lang.Object
  extended by com.tangosol.util.Base
      extended by com.tangosol.util.BitHelper
          extended by com.tangosol.util.ExternalizableHelper
              extended by com.tangosol.util.aggregator.AbstractAggregator
                  extended by com.tangosol.util.aggregator.AbstractBigDecimalAggregator
                      extended by com.tangosol.util.aggregator.BigDecimalAverage

All Implemented Interfaces:
ExternalizableLite, PortableObject, InvocableMap.EntryAggregator, InvocableMap.ParallelAwareAggregator, java.io.Serializable

public class BigDecimalAverage
extends AbstractBigDecimalAggregator

Calculates an average for values of any numberic type extracted from a set of entries in a Map in a form of a BigDecimal value. All the extracted objects will be treated as BigDecimal, BigInteger or Java double values. If the set of entries is empty, a null result is returned.

Since:
Coherence 3.2
Author:
gg 2006.07.18

Field Summary

 

Fields inherited from class com.tangosol.util.aggregator.AbstractBigDecimalAggregator
m_count, m_decResult

 

Fields inherited from class com.tangosol.util.aggregator.AbstractAggregator
m_fParallel

 

Constructor Summary
BigDecimalAverage()
          Default constructor (necessary for the ExternalizableLite interface).
BigDecimalAverage(java.lang.String sMethod)
          Construct an BigDecimalAverage object.
BigDecimalAverage(ValueExtractor extractor)
          Construct a BigDecimalAverage aggregator.

 

Method Summary
protected  java.lang.Object finalizeResult(boolean fFinal)
          Obtain the result of the aggregation. <p/> If the fFinal parameter is true, the returned object must be the final result of the aggregation; otherwise, the returned object will be treated as a partial result that should be incorporated into the final result.
protected  void process(java.lang.Object o, boolean fFinal)
          Incorporate one aggregatable value into the result.

 

Methods inherited from class com.tangosol.util.aggregator.AbstractBigDecimalAggregator
ensureBigDecimal, init

 

Methods inherited from class com.tangosol.util.aggregator.AbstractAggregator
aggregate, aggregateResults, equals, getParallelAggregator, getValueExtractor, hashCode, readExternal, readExternal, toString, writeExternal, writeExternal

 

Methods inherited from class com.tangosol.util.BitHelper
countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, rotateLeft, rotateLeft, rotateLeft, rotateRight, rotateRight, rotateRight, toBitString, toBitString, toBitString

 

Constructor Detail

BigDecimalAverage

public BigDecimalAverage()
Default constructor (necessary for the ExternalizableLite interface).

BigDecimalAverage

public BigDecimalAverage(ValueExtractor extractor)
Construct a BigDecimalAverage aggregator.
Parameters:
extractor - the extractor that provides a value in the form of any Java object that is a Number

BigDecimalAverage

public BigDecimalAverage(java.lang.String sMethod)
Construct an BigDecimalAverage object.
Parameters:
sMethod - the name of the method that returns a value in the form of any Java object that is a Number

Method Detail

process

protected void process(java.lang.Object o,
                       boolean fFinal)
Incorporate one aggregatable value into the result. <p/> If the fFinal parameter is true, the given object is a partial result (returned by an individual parallel aggregator) that should be incorporated into the final result; otherwise, the object is a value extracted from an InvocableMap.Entry.
Specified by:
process in class AbstractAggregator
Parameters:
o - the value to incorporate into the aggregated result
fFinal - true to indicate that the given object is a partial result returned by a parallel aggregator

finalizeResult

protected java.lang.Object finalizeResult(boolean fFinal)
Obtain the result of the aggregation. <p/> If the fFinal parameter is true, the returned object must be the final result of the aggregation; otherwise, the returned object will be treated as a partial result that should be incorporated into the final result.
Overrides:
finalizeResult in class AbstractBigDecimalAggregator
Parameters:
fFinal - true to indicate that the final result of the aggregation process should be returned; this will only be false if a parallel approach is being used
Returns:
the result of the aggregation process

Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


Copyright © 2000, 2009, Oracle. All rights reserved.