coherence::util::aggregator::ComparableMin

ComparableMin Class Reference

#include <coherence/util/aggregator/ComparableMin.hpp>

Detailed Description

Calculates a minimum among values extracted from a set of entries in a Map.

This aggregator is most commonly used with objects that implement Comparable such as String; a Comparator can also be supplied to perform the comparisons.

Author:: djl/pp 2008.05.09

Public Types

typedef spec::Handle Handle

ComparableMin Handle definition.

typedef spec::View View

ComparableMin View definition.

typedef spec::Holder Holder

ComparableMin Holder definition.

Protected Member Functions

ComparableMin ()

Default constructor (necessary for the PortableObject interface).

ComparableMin (ValueExtractor::View vExtractor, Comparator::View vComparator=NULL)

Construct a ComparableMin aggregator.

virtual void process (Object::View v, bool fFinal)

Incorporate one aggregatable value into the result.

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 coherence::util::InvocableMap::Entry.

Parameters:

	vO	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

Constructor & Destructor Documentation

ComparableMin	(	ValueExtractor::View	vExtractor,
		Comparator::View	vComparator = `NULL`
	)			`[protected]`

Construct a ComparableMin aggregator.

Parameters:

	vExtractor	the extractor that provides an object to be compared
	vComparator	the comparator used to compare the extracted object, if NULL then the extracted object must implement Comparable

The documentation for this class was generated from the following file:

coherence/util/aggregator/ComparableMin.hpp