com.rapidminer.operator
Class Value

java.lang.Object
  com.rapidminer.operator.Value

All Implemented Interfaces:

ValueInterface

Direct Known Subclasses:

ValueDouble, ValueString

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 process log operator.

Author:

Ingo Mierswa, Simon Fischer

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.
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

Methods inherited from interface com.rapidminer.operator.ValueInterface

getValue, isNominal

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