com.rapidminer.operator.clustering.clusterer
Class RMAbstractClusterer

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.clustering.clusterer.AbstractClusterer
              com.rapidminer.operator.clustering.clusterer.RMAbstractClusterer

All Implemented Interfaces:

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

Direct Known Subclasses:

DBScan, EMClusterer, FastKMeans, KernelKMeans, KMeans, KMedoids, RandomClustering, SVClustering

public abstract class RMAbstractClusterer
extends AbstractClusterer

Adds a parameter by which the user can choose to generate a cluster attribute. All clusterers other than the Weka clusterers should extends this class rather than AbstractClusterer directly.

Author:

Simon Fischer

Field Summary

static java.lang.String	PARAMETER_ADD_AS_LABEL
static java.lang.String	PARAMETER_ADD_CLUSTER_ATTRIBUTE The parameter name for "Indicates if a cluster id is generated as new special attribute.
static java.lang.String	PARAMETER_REMOVE_UNLABELED

Constructor Summary

RMAbstractClusterer(OperatorDescription description)

Method Summary

protected boolean	addsClusterAttribute() Indicates whether AbstractClusterer.doWork() will add a cluster attribute to the example set.
protected boolean	addsIdAttribute() Indicates whether AbstractClusterer.doWork() will add an id attribute to the example set.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.clustering.clusterer.AbstractClusterer

doWork, generateClusterModel, getAdditionalAttributes, getClusterModelClass, getExampleSetInputPort, shouldAutoConnect

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_ADD_CLUSTER_ATTRIBUTE

public static final java.lang.String PARAMETER_ADD_CLUSTER_ATTRIBUTE

The parameter name for "Indicates if a cluster id is generated as new special attribute."

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

RMAbstractClusterer

public RMAbstractClusterer(OperatorDescription description)

Method Detail

addsClusterAttribute

protected boolean addsClusterAttribute()

Description copied from class: AbstractClusterer

Indicates whether AbstractClusterer.doWork() will add a cluster attribute to the example set.

Specified by:

addsClusterAttribute in class AbstractClusterer

addsIdAttribute

protected boolean addsIdAttribute()

Description copied from class: AbstractClusterer

Indicates whether AbstractClusterer.doWork() will add an id attribute to the example set.

Specified by:

addsIdAttribute in class AbstractClusterer

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