edu.udo.cs.yale.operator
Class Value

java.lang.Object
  edu.udo.cs.yale.operator.Value

All Implemented Interfaces:

ValueInterface

public abstract class Value
extends java.lang.Object
implements ValueInterface

A value contains a key and a description. The current value can be asked by the experiment log operator.

Version:

$Id: Value.java,v 2.11 2006/08/03 14:39:31 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private java.lang.String	description The human readable description of this value.
private boolean	documented Indicates if this value should be documented.
private java.lang.String	key The key which can be asked by the experiment log operator.

Constructor Summary

Value(java.lang.String key, java.lang.String description)
Creates a new Value object with the given key as name and the given description.

Value(java.lang.String key, java.lang.String description, boolean documented)
Creates a new Value object.

Method Summary

java.lang.String	getDescription() Returns a human readable description.
java.lang.String	getKey() Returns the key.
abstract double	getValue() Returns the current value which can be logged by the experiment log operator.
boolean	isDocumented() Returns true if this value should be documented.

Methods inherited from class java.lang.Object

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

Field Detail

key

private java.lang.String key

The key which can be asked by the experiment log operator.

description

private java.lang.String description

The human readable description of this value.

documented

private boolean documented

Indicates if this value should be documented.

Constructor Detail

Value

public Value(java.lang.String key,
             java.lang.String description)

Creates a new Value object with the given key as name and the given description. This value will be documented.

Value

public Value(java.lang.String key,
             java.lang.String description,
             boolean documented)

Creates a new Value object.

Method Detail

getDescription

public java.lang.String getDescription()

Returns a human readable description.

Specified by:

getDescription in interface ValueInterface

getKey

public java.lang.String getKey()

Returns the key.

Specified by:

getKey in interface ValueInterface

isDocumented

public boolean isDocumented()

Returns true if this value should be documented.

Specified by:

isDocumented in interface ValueInterface

getValue

public abstract double getValue()

Returns the current value which can be logged by the experiment log operator.

Specified by:

getValue in interface ValueInterface