com.rapidminer.operator.io
Class ExcelExampleSource

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.io.AbstractReader<ExampleSet>
          com.rapidminer.operator.io.AbstractExampleSource
              com.rapidminer.operator.io.ExcelExampleSource

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class ExcelExampleSource
extends AbstractExampleSource

This operator can be used to load data from Microsoft Excel spreadsheets. This operator is able to reads data from Excel 95, 97, 2000, XP, and 2003. The user has to define which of the spreadsheets in the workbook should be used as data table. The table must have a format so that each line is an example and each column represents an attribute. Please note that the first line might be used for attribute names which can be indicated by a parameter.

The data table can be placed anywhere on the sheet and is allowed to contain arbitrary formatting instructions, empty rows, and empty columns. Missing data values are indicated by empty cells or by cells containing only "?".

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_COLUMN_OFFSET
static java.lang.String	PARAMETER_CREATE_ID
static java.lang.String	PARAMETER_CREATE_LABEL
static java.lang.String	PARAMETER_DATAMANAGEMENT The parameter name for "Determines, how the data is represented internally.
static java.lang.String	PARAMETER_DECIMAL_POINT_CHARACTER The parameter name for "Character that is used as decimal point.
static java.lang.String	PARAMETER_EXCEL_FILE The parameter name for "The Excel spreadsheet file which should be loaded.
static java.lang.String	PARAMETER_FIRST_ROW_AS_NAMES The parameter name for "Indicates if the first row should be used for the attribute names.
static java.lang.String	PARAMETER_ID_COLUMN The parameter name for "Indicates which column should be used for the Id attribute (0: no id)"
static java.lang.String	PARAMETER_LABEL_COLUMN The parameter name for "Indicates which column should be used for the label attribute (0: no label)"
static java.lang.String	PARAMETER_ROW_OFFSET
static java.lang.String	PARAMETER_SHEET_NUMBER The parameter name for "The number of the sheet which should be imported.

Constructor Summary

ExcelExampleSource(OperatorDescription description)

Method Summary

ExampleSet	createExampleSet() Creates (or reads) the ExampleSet that will be returned by AbstractReader.apply().
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.io.AbstractExampleSource

read

Methods inherited from class com.rapidminer.operator.io.AbstractReader

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_EXCEL_FILE

public static final java.lang.String PARAMETER_EXCEL_FILE

The parameter name for "The Excel spreadsheet file which should be loaded."

See Also:

Constant Field Values

PARAMETER_SHEET_NUMBER

public static final java.lang.String PARAMETER_SHEET_NUMBER

The parameter name for "The number of the sheet which should be imported."

See Also:

Constant Field Values

PARAMETER_FIRST_ROW_AS_NAMES

public static final java.lang.String PARAMETER_FIRST_ROW_AS_NAMES

The parameter name for "Indicates if the first row should be used for the attribute names."

See Also:

Constant Field Values

PARAMETER_LABEL_COLUMN

public static final java.lang.String PARAMETER_LABEL_COLUMN

The parameter name for "Indicates which column should be used for the label attribute (0: no label)"

See Also:

Constant Field Values

PARAMETER_ID_COLUMN

public static final java.lang.String PARAMETER_ID_COLUMN

The parameter name for "Indicates which column should be used for the Id attribute (0: no id)"

See Also:

Constant Field Values

PARAMETER_DATAMANAGEMENT

public static final java.lang.String PARAMETER_DATAMANAGEMENT

The parameter name for "Determines, how the data is represented internally."

See Also:

Constant Field Values

PARAMETER_DECIMAL_POINT_CHARACTER

public static final java.lang.String PARAMETER_DECIMAL_POINT_CHARACTER

The parameter name for "Character that is used as decimal point."

See Also:

Constant Field Values

PARAMETER_COLUMN_OFFSET

public static final java.lang.String PARAMETER_COLUMN_OFFSET

See Also:

Constant Field Values

PARAMETER_ROW_OFFSET

public static final java.lang.String PARAMETER_ROW_OFFSET

See Also:

Constant Field Values

PARAMETER_CREATE_LABEL

public static final java.lang.String PARAMETER_CREATE_LABEL

See Also:

Constant Field Values

PARAMETER_CREATE_ID

public static final java.lang.String PARAMETER_CREATE_ID

See Also:

Constant Field Values

Constructor Detail

ExcelExampleSource

public ExcelExampleSource(OperatorDescription description)

Method Detail

createExampleSet

public ExampleSet createExampleSet()
                            throws OperatorException

Description copied from class: AbstractExampleSource

Creates (or reads) the ExampleSet that will be returned by AbstractReader.apply().

Specified by:

createExampleSet in class AbstractExampleSource

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