com.rapidminer.operator.performance
Class PerformanceVector

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.tools.math.AverageVector
              com.rapidminer.operator.performance.PerformanceVector

All Implemented Interfaces:

IOObject, ResultObject, LoggingHandler, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class PerformanceVector
extends AverageVector

Handles several performance criteria. It is possible to obtain more than one criterion and therefore they are added to a criteria list.

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Nested Class Summary

static class

PerformanceVector.DefaultComparator The default performance comparator compares the main criterion of two performance vectors.

Nested classes/interfaces inherited from class com.rapidminer.operator.AbstractIOObject

AbstractIOObject.InputStreamProvider

Field Summary

static java.lang.String

MAIN_CRITERION_FIRST

Constructor Summary

PerformanceVector()

Method Summary

void	addCriterion(PerformanceCriterion crit)
java.lang.Object	clone()
int	compareTo(java.lang.Object o) Returns a negative value iff o is better than this performance vector
java.lang.String[]	getCriteriaNames()
PerformanceCriterion	getCriterion(int index)
PerformanceCriterion	getCriterion(java.lang.String name)
java.lang.String	getExtension()
java.lang.String	getFileDescription()
PerformanceCriterion	getMainCriterion() Returns the main PerformanceCriterion.
void	initWriting() Init the value map which ensures an easy human readable format.
void	setComparator(PerformanceComparator comparator)
void	setMainCriterionName(java.lang.String mcName) Sets the name of the main average (must be added by AverageVector.addAveragable(Averagable))
java.lang.String	toString()

Methods inherited from class com.rapidminer.tools.math.AverageVector

addAveragable, buildAverages, equals, getAveragable, getAveragable, getSize, hashCode, removeAveragable, size, toResultString

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, getAnnotations, getName, getResultIcon, log, log, logError, logNote, logWarning, toHTML

Methods inherited from class com.rapidminer.operator.AbstractIOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, read, read, read, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rapidminer.operator.IOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, setLoggingHandler, setSource, write

Field Detail

MAIN_CRITERION_FIRST

public static final java.lang.String MAIN_CRITERION_FIRST

See Also:

Constant Field Values

Constructor Detail

PerformanceVector

public PerformanceVector()

Method Detail

setComparator

public void setComparator(PerformanceComparator comparator)

addCriterion

public void addCriterion(PerformanceCriterion crit)

getCriterion

public PerformanceCriterion getCriterion(int index)

getCriterion

public PerformanceCriterion getCriterion(java.lang.String name)

getCriteriaNames

public java.lang.String[] getCriteriaNames()

setMainCriterionName

public void setMainCriterionName(java.lang.String mcName)

Sets the name of the main average (must be added by AverageVector.addAveragable(Averagable))

getMainCriterion

public PerformanceCriterion getMainCriterion()

Returns the main PerformanceCriterion. If the main criterion is not specified by setMainCriterionName(String), the first criterion is returned.

compareTo

public int compareTo(java.lang.Object o)

Returns a negative value iff o is better than this performance vector

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in class AverageVector

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class AverageVector

getExtension

public java.lang.String getExtension()

getFileDescription

public java.lang.String getFileDescription()

initWriting

public void initWriting()

Init the value map which ensures an easy human readable format.

Overrides:

initWriting in class AbstractIOObject