00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_FLOAT64_AVERAGE_HPP 00008 #define COH_FLOAT64_AVERAGE_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/aggregator/AbstractFloat64Aggregator.hpp" 00013 #include "coherence/util/ValueExtractor.hpp" 00014 00015 COH_OPEN_NAMESPACE3(coherence,util,aggregator) 00016 00017 00018 /** 00019 * Calculates an average for values of any numberic type extracted from a set 00020 * of entries in a Map. All the extracted Number objects will be treated as 00021 * <tt>float64_t</tt> values. If the set of entries is empty, a 00022 * <tt>NULL</tt> result is returned. 00023 * 00024 * @author djl 2008.05.09 00025 */ 00026 class COH_EXPORT Float64Average 00027 : public class_spec<Float64Average, 00028 extends<AbstractFloat64Aggregator> > 00029 { 00030 friend class factory<Float64Average>; 00031 00032 // ----- constructors --------------------------------------------------- 00033 00034 protected: 00035 /** 00036 * Default constructor (necessary for the PortableObject interface). 00037 */ 00038 Float64Average(); 00039 00040 /** 00041 * Construct a Float64Average aggregator. 00042 * 00043 * @param vExtractor the extractor that provides a value in the form 00044 * of any object that is a Number 00045 */ 00046 Float64Average(ValueExtractor::View vExtractor); 00047 00048 /** 00049 * Construct an Float64Average that will aggregate values extracted 00050 * from a set of InvocableMap::Entry objects. 00051 * 00052 * @param vsMethod the name of the method that could be invoked via 00053 * reflection and that returns values to aggregate; 00054 * this parameter can also be a dot-delimited 00055 * sequence of method names which would result in 00056 * an aggregator based on the ChainedExtractor that 00057 * is based on an array of corresponding 00058 * ReflectionExtractor objects 00059 * 00060 * @since Coherence 12.1.2 00061 */ 00062 Float64Average(String::View vsMethod); 00063 00064 private: 00065 /** 00066 * Blocked copy constructor. 00067 */ 00068 Float64Average(const Float64Average&); 00069 00070 00071 // ----- AbstractAggregator Interface ---------------------------------- 00072 00073 protected: 00074 /** 00075 * {@inheritDoc} 00076 */ 00077 virtual void init(bool fFinal); 00078 00079 /** 00080 * {@inheritDoc} 00081 */ 00082 virtual void process(Object::View v, bool fFinal); 00083 00084 /** 00085 * {@inheritDoc} 00086 */ 00087 virtual Object::Holder finalizeResult(bool fFinal); 00088 }; 00089 00090 COH_CLOSE_NAMESPACE3 00091 00092 #endif // COH_FLOAT64_AVERAGE_HPP