com.rapidminer.operator.preprocessing.series.filter
Class IndexSeries

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.series.AbstractSeriesProcessing
              com.rapidminer.operator.preprocessing.series.filter.IndexSeries

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class IndexSeries
extends AbstractSeriesProcessing

Creates an index series from an original series. The index anchor can be set to the first or last example meaning that the index is equal to 1 at the first or last example.

Author:

Tobias Malbrecht

Field Summary

static int	INDEX_ANCHOR_FIRST
static int	INDEX_ANCHOR_ID
static int	INDEX_ANCHOR_LAST
static java.lang.String[]	INDEX_ANCHORS
static java.lang.String	PARAMETER_ATTRIBUTE_NAME
static java.lang.String	PARAMETER_INDEX_ANCHOR
static java.lang.String	PARAMETER_INDEX_ANCHOR_ID
static java.lang.String	PARAMETER_KEEP_ORIGINAL_ATTRIBUTE

Constructor Summary

IndexSeries(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.AbstractExampleSetProcessing

apply, getInputClasses, getOutputClasses

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

public static final java.lang.String PARAMETER_ATTRIBUTE_NAME

See Also:

Constant Field Values

PARAMETER_INDEX_ANCHOR

public static final java.lang.String PARAMETER_INDEX_ANCHOR

See Also:

Constant Field Values

INDEX_ANCHORS

public static final java.lang.String[] INDEX_ANCHORS

INDEX_ANCHOR_FIRST

public static final int INDEX_ANCHOR_FIRST

See Also:

Constant Field Values

INDEX_ANCHOR_LAST

public static final int INDEX_ANCHOR_LAST

See Also:

Constant Field Values

INDEX_ANCHOR_ID

public static final int INDEX_ANCHOR_ID

See Also:

Constant Field Values

PARAMETER_INDEX_ANCHOR_ID

public static final java.lang.String PARAMETER_INDEX_ANCHOR_ID

See Also:

Constant Field Values

PARAMETER_KEEP_ORIGINAL_ATTRIBUTE

public static final java.lang.String PARAMETER_KEEP_ORIGINAL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

IndexSeries

public IndexSeries(OperatorDescription description)

Method Detail

apply

public ExampleSet apply(ExampleSet exampleSet)
                 throws OperatorException

Description copied from class: AbstractExampleSetProcessing

Delegate for the apply method. In most cases, the returned example set will be the same as the example set or a modified clone.

Specified by:

apply in class AbstractExampleSetProcessing

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.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator