com.rapidminer.operator.clustering
Class ClusterModel2ExampleSet

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.clustering.ClusterModel2ExampleSet

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ResourceConsumer, ParameterHandler, LoggingHandler, Observable<Operator>

public class ClusterModel2ExampleSet
extends Operator

This Operator clusters an exampleset given a cluster model. If an exampleSet does not contain an id attribute it is probably not the same as the cluster model has been created on. Since cluster models depend on a static nature of the id attributes, the outcome on another exampleset with different values but same ids will be unpredictable and hence not automatically creation of ids is performed. Only centroid based clusterings support assiging unseen examples to clusters. *

Author:

Sebastian Land

Field Summary

static java.lang.String	PARAMETER_ADD_AS_LABEL
static java.lang.String	PARAMETER_KEEP_MODEL
static java.lang.String	PARAMETER_REMOVE_UNLABELED

Constructor Summary

ClusterModel2ExampleSet(OperatorDescription description)

Method Summary

ExampleSet	addClusterAttribute(ExampleSet exampleSet, ClusterModel model)
void	doWork() Performs the actual work of the operator and must be implemented by subclasses.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
boolean	shouldAutoConnect(OutputPort port) By default, all ports will be auto-connected by ExecutionUnit.autoWire(CompatibilityLevel, boolean, boolean).

Methods inherited from class com.rapidminer.operator.Operator

acceptsInput, addError, addError, addValue, addWarning, apply, apply, assumePreconditionsSatisfied, checkAll, checkAllExcludingMetaData, checkDeprecations, checkForStop, checkIO, checkProperties, clear, clearErrorList, cloneOperator, collectErrors, createExperimentTree, createExperimentTree, createFromXML, createFromXML, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, disconnectPorts, execute, fireUpdate, freeMemory, getAddOnlyAdditionalOutput, getApplyCount, getCompatibilityLevel, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getDOMRepresentation, getEncoding, getErrorList, getExecutionUnit, getExperiment, getIncompatibleVersionChanges, getInput, getInput, getInput, getInputClasses, getInputDescription, getInputPorts, getIODescription, getLog, getLogger, getName, getNumberOfBreakpoints, getOperatorClassName, getOperatorDescription, getOutputClasses, getOutputPorts, getParameter, getParameterAsBoolean, getParameterAsChar, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsRepositoryLocation, getParameterAsString, getParameterHandler, getParameterList, getParameters, getParameterTupel, getParameterType, getParent, getPortOwner, getProcess, getResourceConsumptionEstimator, getRoot, getStartTime, getTransformer, getUserDescription, getValue, getValues, getXML, getXML, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isDirty, isEnabled, isExpanded, isParallel, isParameterSet, isRunning, log, log, logError, logNote, logWarning, lookupOperator, makeDirty, makeDirtyOnUpdate, notifyRenaming, performAdditionalChecks, preAutoWire, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, shouldStopStandaloneExecution, toString, transformMetaData, unregisterOperator, updateExecutionOrder, walk, writeXML, writeXML

Methods inherited from class com.rapidminer.tools.AbstractObservable

addObserver, addObserverAsFirst, fireUpdate, removeObserver

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_KEEP_MODEL

public static final java.lang.String PARAMETER_KEEP_MODEL

See Also:

Constant Field Values

PARAMETER_REMOVE_UNLABELED

public static final java.lang.String PARAMETER_REMOVE_UNLABELED

See Also:

Constant Field Values

PARAMETER_ADD_AS_LABEL

public static final java.lang.String PARAMETER_ADD_AS_LABEL

See Also:

Constant Field Values

Constructor Detail

ClusterModel2ExampleSet

public ClusterModel2ExampleSet(OperatorDescription description)

Method Detail

addClusterAttribute

public ExampleSet addClusterAttribute(ExampleSet exampleSet,
                                      ClusterModel model)
                               throws OperatorException

Throws:

OperatorException

doWork

public void doWork()
            throws OperatorException

Description copied from class: Operator

Performs the actual work of the operator and must be implemented by subclasses. Replaces the old method apply().

Overrides:

doWork in class Operator

Throws:

OperatorException

shouldAutoConnect

public boolean shouldAutoConnect(OutputPort port)

Description copied from class: Operator

By default, all ports will be auto-connected by ExecutionUnit.autoWire(CompatibilityLevel, boolean, boolean). Optional outputs were handled up to version 4.4 by parameters. From 5.0 on, optional outputs are computed iff the corresponding port is connected. For backward compatibility, operators can check if we should auto-connect a port by overriding this method (e.g. by checking a deprecated parameter). TODO: Remove in later versions

Overrides:

shouldAutoConnect in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed. ATTENTION! This will create new parameterTypes. For calling already existing parameter types use getParameters().getParameterTypes();

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator