com.rapidminer.operator.visualization.dependencies
Class AbstractPairwiseMatrixOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.visualization.dependencies.AbstractPairwiseMatrixOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

MutualInformationMatrixOperator

public abstract class AbstractPairwiseMatrixOperator
extends Operator

This operator calculates a dependency matrix between all attributes of the input example set. This operator simply produces a dependency matrix like, for example, a correlation matrix. Such matrixes up to now cannot be used by other operators but can be displayed to the user in the result tab.

Please note that this simple implementation performs a data scan for each attribute combination and might therefore take some time for non-memory example tables.

Author:

Ingo Mierswa

Constructor Summary

AbstractPairwiseMatrixOperator(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
abstract java.lang.String	getMatrixName()
abstract double	getMatrixValue(ExampleSet exampleSet, Attribute firstAttribute, Attribute secondAttribute)
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
protected ExampleSet	performPreprocessing(ExampleSet exampleSet) This default implementation does nothing.

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParameterTypes, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPairwiseMatrixOperator

public AbstractPairwiseMatrixOperator(OperatorDescription description)

Method Detail

getMatrixName

public abstract java.lang.String getMatrixName()

getMatrixValue

public abstract double getMatrixValue(ExampleSet exampleSet,
                                      Attribute firstAttribute,
                                      Attribute secondAttribute)

performPreprocessing

protected ExampleSet performPreprocessing(ExampleSet exampleSet)
                                   throws OperatorException

This default implementation does nothing. Subclasses might calculate for example a discretization but should either deliver a new view or a fresh example set in order to not change the underlying data.

Throws:

OperatorException

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator