MOEA Framework 2.12
API Specification

org.moeaframework.analysis.collector
Interface Collector

All Known Implementing Classes:
AdaptiveMultimethodVariationCollector, AdaptiveTimeContinuationCollector, ApproximationSetCollector, ElapsedTimeCollector, EpsilonProgressCollector, IndicatorCollector, PopulationSizeCollector

public interface Collector

Collects information from an object. In general, the object will be an algorithm or an object stored within an algorithm. Collectors have two states: attached and unattached. Collectors are initially unattached, and are attached to an appropriate object, called the attach point, by invoking attach(Object). Once attached, the collect(Accumulator) may be invoked.


Method Summary
 Collector attach(Object object)
          Returns a new instance of this collector which has been attached to the specified object as identified by the attach point returned through getAttachPoint().
 void collect(Accumulator accumulator)
          Collects the necessary information from the object, storing the data to the specified accumulator.
 AttachPoint getAttachPoint()
          Returns the attach point describing where this collector is attached.
 

Method Detail

getAttachPoint

AttachPoint getAttachPoint()
Returns the attach point describing where this collector is attached. The matched object should be unique.

Returns:
the attach point describing where this collector is attached

attach

Collector attach(Object object)
Returns a new instance of this collector which has been attached to the specified object as identified by the attach point returned through getAttachPoint().

Parameters:
object - the matching object
Returns:
a new instance of this collector which has been attached to the specified object

collect

void collect(Accumulator accumulator)
Collects the necessary information from the object, storing the data to the specified accumulator. This method must only be invoked after this collector has been attached to an appropriate object.

Parameters:
accumulator - the accumulator to which the collected data is stored

MOEA Framework 2.12
API Specification

Copyright 2009-2016 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Visit us on Github!