com.rapidminer.operator.learner.associations.gsp
Class GSPOperator

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.learner.associations.gsp.GSPOperator

All Implemented Interfaces:

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

public class GSPOperator
extends Operator

This operator searches sequential patterns in a set of transactions. Each transaction must be encoded as an single example and must contain one attribute for the time and for the customer. This pair of attribute is used for generate one sequence per customer containing each single transaction ordered by the time of each transaction. The algorithm then searches sequential patterns in the form of: If a customer bought a and c in one transaction, he bought b in the next: then . The minimal support describes how many customer must support such a pattern for regarding it as frequent. Infrequent patterns will be dropped. A customer supports such a pattern, if there are some parts of his sequence including the pattern. The above pattern would be supported by a customer with this transactions: then then then . The parameters min_gap, max_gap and window_size determine how transaction are handled. For example, if the above customer forgot to by c, and had to return 5 minutes later to buy c, then his transactions would look like that: then then then then This would not support the pattern then . To avoid this problem, the window size determines, how long a subsequent transaction is treated as the same transaction. If the window size is larger than 5 minutes, the would be treated as being part of the second transaction and hence this customer would support the above pattern. The max_gap parameter causes a customers sequence not to support a pattern, if the transactions containing this pattern are to widely separated in time. The min_gap parameter does the same if they are to near.

Author:

Sebastian Land

Field Summary

static java.lang.String	CUSTOMER_ROLE
static java.lang.String	PARAMETER_CUSTOMER_ATTRIBUTE
static java.lang.String	PARAMETER_MAX_GAP
static java.lang.String	PARAMETER_MIN_GAP
static java.lang.String	PARAMETER_MIN_SUPPORT
static java.lang.String	PARAMETER_POSITIVE_VALUE
static java.lang.String	PARAMETER_TIME_ATTRIBUTE
static java.lang.String	PARAMETER_WINDOW_SIZE
static java.lang.String	TIME_ROLE

Constructor Summary

GSPOperator(OperatorDescription description)

Method Summary

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.

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, 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

TIME_ROLE

public static final java.lang.String TIME_ROLE

See Also:

Constant Field Values

CUSTOMER_ROLE

public static final java.lang.String CUSTOMER_ROLE

See Also:

Constant Field Values

PARAMETER_CUSTOMER_ATTRIBUTE

public static final java.lang.String PARAMETER_CUSTOMER_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_TIME_ATTRIBUTE

public static final java.lang.String PARAMETER_TIME_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_WINDOW_SIZE

public static final java.lang.String PARAMETER_WINDOW_SIZE

See Also:

Constant Field Values

PARAMETER_MAX_GAP

public static final java.lang.String PARAMETER_MAX_GAP

See Also:

Constant Field Values

PARAMETER_MIN_GAP

public static final java.lang.String PARAMETER_MIN_GAP

See Also:

Constant Field Values

PARAMETER_POSITIVE_VALUE

public static final java.lang.String PARAMETER_POSITIVE_VALUE

See Also:

Constant Field Values

PARAMETER_MIN_SUPPORT

public static final java.lang.String PARAMETER_MIN_SUPPORT

See Also:

Constant Field Values

Constructor Detail

GSPOperator

public GSPOperator(OperatorDescription description)

Method Detail

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

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