com.rapidminer.operator.learner.associations
Class AssociationRuleGenerator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.learner.associations.AssociationRuleGenerator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class AssociationRuleGenerator
extends Operator

This operator generates association rules from frequent item sets. In RapidMiner, the process of frequent item set mining is divided into two parts: first, the generation of frequent item sets and second, the generation of association rules from these sets.

For the generation of frequent item sets, you can use for example the operator FPGrowth. The result will be a set of frequent item sets which could be used as input for this operator.

Author:

Sebastian Land, Ingo Mierswa

Field Summary

static int	CONFIDENCE
static int	CONVICTION
static java.lang.String[]	CRITERIA
static int	GAIN
static int	LAPLACE
static int	LIFT
static java.lang.String	PARAMETER_CRITERION
static java.lang.String	PARAMETER_GAIN_THETA
static java.lang.String	PARAMETER_LAPLACE_K
static java.lang.String	PARAMETER_MIN_CONFIDENCE
static java.lang.String	PARAMETER_MIN_CRITERION_VALUE
static int	PS

Constructor Summary

AssociationRuleGenerator(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
InputDescription	getInputDescription(java.lang.Class cls) Indicates that the consumption of frequent item sets can be user defined.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

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, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, 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

Field Detail

PARAMETER_CRITERION

public static final java.lang.String PARAMETER_CRITERION

See Also:

Constant Field Values

PARAMETER_MIN_CONFIDENCE

public static final java.lang.String PARAMETER_MIN_CONFIDENCE

See Also:

Constant Field Values

PARAMETER_MIN_CRITERION_VALUE

public static final java.lang.String PARAMETER_MIN_CRITERION_VALUE

See Also:

Constant Field Values

PARAMETER_GAIN_THETA

public static final java.lang.String PARAMETER_GAIN_THETA

See Also:

Constant Field Values

PARAMETER_LAPLACE_K

public static final java.lang.String PARAMETER_LAPLACE_K

See Also:

Constant Field Values

CRITERIA

public static final java.lang.String[] CRITERIA

CONFIDENCE

public static final int CONFIDENCE

See Also:

Constant Field Values

LIFT

public static final int LIFT

See Also:

Constant Field Values

CONVICTION

public static final int CONVICTION

See Also:

Constant Field Values

PS

public static final int PS

See Also:

Constant Field Values

GAIN

public static final int GAIN

See Also:

Constant Field Values

LAPLACE

public static final int LAPLACE

See Also:

Constant Field Values

Constructor Detail

AssociationRuleGenerator

public AssociationRuleGenerator(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputDescription

public InputDescription getInputDescription(java.lang.Class cls)

Indicates that the consumption of frequent item sets can be user defined.

Overrides:

getInputDescription in class Operator

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

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.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator