com.rapidminer.operator.nio.model
Class AbstractDataResultSetReader

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVExampleSource, ExcelExampleSource

public abstract class AbstractDataResultSetReader
extends AbstractExampleSource

This class uses DataResultSets to load data from file and then delivers the data as an example set.

Author:

Sebastian Land

Nested Class Summary

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

AbstractReader.ReaderDescription

Field Summary

static java.lang.String	ANNOTATION_NAME Pseudo-annotation to be used for attribute names.
static java.lang.String	PARAMETER_ANNOTATIONS
static java.lang.String	PARAMETER_COLUMN_INDEX Parameters being part of the list for PARAMETER_META_DATA
static java.lang.String	PARAMETER_COLUMN_META_DATA
static java.lang.String	PARAMETER_COLUMN_NAME
static java.lang.String	PARAMETER_COLUMN_ROLE
static java.lang.String	PARAMETER_COLUMN_SELECTED
static java.lang.String	PARAMETER_COLUMN_VALUE_TYPE
static java.lang.String	PARAMETER_DATAMANAGEMENT The parameter name for "Determines, how the data is represented internally.
static java.lang.String	PARAMETER_DATE_FORMAT
static java.lang.String	PARAMETER_ERROR_TOLERANT
static java.lang.String	PARAMETER_FIRST_ROW_AS_NAMES
static java.lang.String	PARAMETER_LOCALE
static java.lang.String	PARAMETER_META_DATA This parameter holds the hole information about the attribute columns.
static java.lang.String	PARAMETER_TIME_ZONE

Constructor Summary

AbstractDataResultSetReader(OperatorDescription description)

Method Summary

ExampleSet	createExampleSet() Creates (or reads) the ExampleSet that will be returned by Operator.apply().
protected abstract DataResultSetFactory	getDataResultSetFactory() Must be implemented by subclasses to return the DataResultSet.
MetaData	getGeneratedMetaData()
protected abstract 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.

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

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

ANNOTATION_NAME

public static final java.lang.String ANNOTATION_NAME

Pseudo-annotation to be used for attribute names.

See Also:

Constant Field Values

PARAMETER_META_DATA

public static final java.lang.String PARAMETER_META_DATA

This parameter holds the hole information about the attribute columns. I.e. which attributes are defined, the names, what value type they have, whether the att. is selected,

See Also:

Constant Field Values

PARAMETER_COLUMN_INDEX

public static final java.lang.String PARAMETER_COLUMN_INDEX

Parameters being part of the list for PARAMETER_META_DATA

See Also:

Constant Field Values

PARAMETER_COLUMN_META_DATA

public static final java.lang.String PARAMETER_COLUMN_META_DATA

See Also:

Constant Field Values

PARAMETER_COLUMN_NAME

public static final java.lang.String PARAMETER_COLUMN_NAME

See Also:

Constant Field Values

PARAMETER_COLUMN_SELECTED

public static final java.lang.String PARAMETER_COLUMN_SELECTED

See Also:

Constant Field Values

PARAMETER_COLUMN_VALUE_TYPE

public static final java.lang.String PARAMETER_COLUMN_VALUE_TYPE

See Also:

Constant Field Values

PARAMETER_COLUMN_ROLE

public static final java.lang.String PARAMETER_COLUMN_ROLE

See Also:

Constant Field Values

PARAMETER_DATE_FORMAT

public static final java.lang.String PARAMETER_DATE_FORMAT

See Also:

Constant Field Values

PARAMETER_TIME_ZONE

public static final java.lang.String PARAMETER_TIME_ZONE

See Also:

Constant Field Values

PARAMETER_LOCALE

public static final java.lang.String PARAMETER_LOCALE

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_FIRST_ROW_AS_NAMES

public static final java.lang.String PARAMETER_FIRST_ROW_AS_NAMES

See Also:

Constant Field Values

PARAMETER_ANNOTATIONS

public static final java.lang.String PARAMETER_ANNOTATIONS

See Also:

Constant Field Values

PARAMETER_ERROR_TOLERANT

public static final java.lang.String PARAMETER_ERROR_TOLERANT

See Also:

Constant Field Values

Constructor Detail

AbstractDataResultSetReader

public AbstractDataResultSetReader(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 Operator.apply().

Specified by:

createExampleSet in class AbstractExampleSource

Throws:

OperatorException

getGeneratedMetaData

public MetaData getGeneratedMetaData()
                              throws OperatorException

Overrides:

getGeneratedMetaData in class AbstractExampleSource

Throws:

OperatorException

getDataResultSetFactory

protected abstract DataResultSetFactory getDataResultSetFactory()
                                                         throws OperatorException

Must be implemented by subclasses to return the DataResultSet.

Throws:

OperatorException

getNumberFormat

protected abstract java.text.NumberFormat getNumberFormat()
                                                   throws OperatorException

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

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 AbstractReader<ExampleSet>