com.rapidminer.operator.nio
Class CSVExampleSource

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.io.AbstractReader<ExampleSet>
              com.rapidminer.operator.io.AbstractExampleSource
                  com.rapidminer.operator.nio.model.AbstractDataResultSetReader
                      com.rapidminer.operator.nio.CSVExampleSource

All Implemented Interfaces:

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

public class CSVExampleSource
extends AbstractDataResultSetReader

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, Tobias Malbrecht, Sebastian Loh, Sebastian Land, Simon Fischer

Nested Class Summary

Nested classes/interfaces inherited from class com.rapidminer.operator.io.AbstractReader

AbstractReader.ReaderDescription

Field Summary

static java.lang.String	PARAMETER_COLUMN_SEPARATORS
static java.lang.String	PARAMETER_COMMENT_CHARS
static java.lang.String	PARAMETER_CSV_FILE
static java.lang.String	PARAMETER_ESCAPE_CHARACTER
static java.lang.String	PARAMETER_QUOTES_CHARACTER
static java.lang.String	PARAMETER_SKIP_COMMENTS
static java.lang.String	PARAMETER_TRIM_LINES
static java.lang.String	PARAMETER_USE_QUOTES

Fields inherited from class com.rapidminer.operator.nio.model.AbstractDataResultSetReader

ANNOTATION_NAME, PARAMETER_ANNOTATIONS, PARAMETER_COLUMN_INDEX, PARAMETER_COLUMN_META_DATA, PARAMETER_COLUMN_NAME, PARAMETER_COLUMN_ROLE, PARAMETER_COLUMN_SELECTED, PARAMETER_COLUMN_VALUE_TYPE, PARAMETER_DATAMANAGEMENT, PARAMETER_DATE_FORMAT, PARAMETER_ERROR_TOLERANT, PARAMETER_FIRST_ROW_AS_NAMES, PARAMETER_LOCALE, PARAMETER_META_DATA, PARAMETER_TIME_ZONE

Constructor Summary

CSVExampleSource(OperatorDescription description)

Method Summary

protected DataResultSetFactory	getDataResultSetFactory() Must be implemented by subclasses to return the DataResultSet.
protected java.lang.String	getFileExtension() Returns the allowed file extension.
protected java.lang.String	getFileParameterName() Returns the name of the ParameterTypeFile to be added through which the user can specify the file name.
protected java.text.NumberFormat	getNumberFormat() Returns the configured number format or null if a default number format should be used.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
protected boolean	supportsEncoding()

Methods inherited from class com.rapidminer.operator.nio.model.AbstractDataResultSetReader

createExampleSet, getFileExtensions, getFileInputPort, getGeneratedMetaData, getSelectedFile, isFileSpecified, isSupportingFirstRowAsNames, makeFileParameterType, openSelectedFile

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

read

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

addAnnotations, canMakeReaderFor, createReader, doWork, getFileParameterForOperator, isMetaDataCacheable, registerOperator, registerReaderDescription

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

PARAMETER_CSV_FILE

public static final java.lang.String PARAMETER_CSV_FILE

See Also:

Constant Field Values

PARAMETER_TRIM_LINES

public static final java.lang.String PARAMETER_TRIM_LINES

See Also:

Constant Field Values

PARAMETER_SKIP_COMMENTS

public static final java.lang.String PARAMETER_SKIP_COMMENTS

See Also:

Constant Field Values

PARAMETER_COMMENT_CHARS

public static final java.lang.String PARAMETER_COMMENT_CHARS

See Also:

Constant Field Values

PARAMETER_USE_QUOTES

public static final java.lang.String PARAMETER_USE_QUOTES

See Also:

Constant Field Values

PARAMETER_QUOTES_CHARACTER

public static final java.lang.String PARAMETER_QUOTES_CHARACTER

See Also:

Constant Field Values

PARAMETER_COLUMN_SEPARATORS

public static final java.lang.String PARAMETER_COLUMN_SEPARATORS

See Also:

Constant Field Values

PARAMETER_ESCAPE_CHARACTER

public static final java.lang.String PARAMETER_ESCAPE_CHARACTER

See Also:

Constant Field Values

Constructor Detail

CSVExampleSource

public CSVExampleSource(OperatorDescription description)

Method Detail

getDataResultSetFactory

protected DataResultSetFactory getDataResultSetFactory()
                                                throws OperatorException

Description copied from class: AbstractDataResultSetReader

Must be implemented by subclasses to return the DataResultSet.

Specified by:

getDataResultSetFactory in class AbstractDataResultSetReader

Throws:

OperatorException

getNumberFormat

protected java.text.NumberFormat getNumberFormat()
                                          throws OperatorException

Description copied from class: AbstractDataResultSetReader

Returns the configured number format or null if a default number format should be used.

Specified by:

getNumberFormat in class AbstractDataResultSetReader

Throws:

OperatorException

supportsEncoding

protected boolean supportsEncoding()

Overrides:

supportsEncoding in class AbstractReader<ExampleSet>

getFileParameterName

protected java.lang.String getFileParameterName()

Description copied from class: AbstractDataResultSetReader

Returns the name of the ParameterTypeFile to be added through which the user can specify the file name.

Specified by:

getFileParameterName in class AbstractDataResultSetReader

getFileExtension

protected java.lang.String getFileExtension()

Description copied from class: AbstractDataResultSetReader

Returns the allowed file extension.

Specified by:

getFileExtension in class AbstractDataResultSetReader

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 AbstractDataResultSetReader