org.uma.jmetal.measure.impl

Class PullPushMeasure<Value>

java.lang.Object

org.uma.jmetal.measure.impl.PullPushMeasure<Value>

Type Parameters:

Value -

All Implemented Interfaces:

Serializable, Measure<Value>, PullMeasure<Value>, PushMeasure<Value>, DescribedEntity

public class PullPushMeasure<Value>
extends Object
implements PullMeasure<Value>, PushMeasure<Value>

A PullPushMeasure aims at providing both the PushMeasure and PullMeasure abilities into a single Measure. One could simply build a brand new Measure by calling PullPushMeasure(String, String), but in the case where some existing measures are available, he can wrap them into a PullPushMeasure by calling PullPushMeasure(PushMeasure, Object) or other constructors taking a Measure as argument.

Author:

Matthieu Vergne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PullPushMeasure(PullMeasure<Value> pull, PushMeasure<Value> push, DescribedEntity reference) Create a PullPushMeasure which wraps both a PullMeasure and a PushMeasure.
PullPushMeasure(PullMeasure<Value> pull, PushMeasure<Value> push, String name, String description) Equivalent to PullPushMeasure(PullMeasure, PushMeasure, DescribedEntity) but the reference parameter is replaced by the specific name and description that you want to provide.
PullPushMeasure(PushMeasure<Value> push, Value initialValue) Create a PullPushMeasure which wraps a PushMeasure.
PullPushMeasure(String name, String description) Create a PullPushMeasure from scratch.

Method Summary

Modifier and Type	Method and Description
Value	get()
String	getDescription()
String	getName()
void	register(MeasureListener<Value> listener) Register a MeasureListener to use the Values of the PushMeasure when they are generated.
void	unregister(MeasureListener<Value> listener) Unregister a MeasureListener registered with PushMeasure.register(MeasureListener) to stop receiving the notifications of the PushMeasure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PullPushMeasure

public PullPushMeasure(PullMeasure<Value> pull,
                       PushMeasure<Value> push,
                       DescribedEntity reference)

Create a PullPushMeasure which wraps both a PullMeasure and a PushMeasure. The assumption is that both Measures already represent the same Measure (i.e. the same Value) but were implemented separately. Instantiating a PullPushMeasure this way allows to merge them easily without creating a completely new measure. Don't use this constructor to merge two different Measures. The last parameter is generally used to specify which of the two Measures should be used for getName() and getDescription(), but you can also provide a completely new instance to change them.

Parameters:

pull - the PullMeasure to wrap

push - the PushMeasure to wrap

reference - the reference to use for the name and the description of this PullPushMeasure

PullPushMeasure

public PullPushMeasure(PullMeasure<Value> pull,
                       PushMeasure<Value> push,
                       String name,
                       String description)

Equivalent to PullPushMeasure(PullMeasure, PushMeasure, DescribedEntity) but the reference parameter is replaced by the specific name and description that you want to provide. This is a shortcut to the creation of the DescribedEntity instance followed by the call of the reference-based method.

Parameters:

pull - the PullMeasure to wrap

push - the PushMeasure to wrap

name - the name of the PullPushMeasure

description - the description of the PullPushMeasure

PullPushMeasure

public PullPushMeasure(PushMeasure<Value> push,
                       Value initialValue)

Create a PullPushMeasure which wraps a PushMeasure. The PullMeasure ability corresponds the storage of the Value pushed by the PushMeasure in order to retrieve it on demand through PullMeasure.get(). The name and the description of the PullPushMeasure are the ones provided by the wrapped PushMeasure.

Parameters:

push - the PushMeasure to wraps

initialValue - the Value to return before the next notification of the PushMeasure

PullPushMeasure

public PullPushMeasure(String name,
                       String description)

Create a PullPushMeasure from scratch.

Parameters:

name - the name of the PullPushMeasure

description - the description of the PullPushMeasure

Method Detail

register

public void register(MeasureListener<Value> listener)

Description copied from interface: PushMeasure

Register a MeasureListener to use the Values of the PushMeasure when they are generated.

Specified by:

register in interface PushMeasure<Value>

Parameters:

listener - the MeasureListener to register

unregister

public void unregister(MeasureListener<Value> listener)

Description copied from interface: PushMeasure

Unregister a MeasureListener registered with PushMeasure.register(MeasureListener) to stop receiving the notifications of the PushMeasure.

Specified by:

unregister in interface PushMeasure<Value>

Parameters:

listener - the MeasureListener to unregister

get

public Value get()

Specified by:

get in interface PullMeasure<Value>

Returns:

the current Value of the Measure

getName

public String getName()

Specified by:

getName in interface DescribedEntity

Returns:

the name of the DescribedEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface DescribedEntity

Returns:

the description of the DescribedEntity