com.rapidminer.operator.io
Class ResultSetExampleSource

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

DatabaseExampleSource, KDBExampleSource

public abstract class ResultSetExampleSource
extends AbstractExampleSource

Abstract superclass for operators that provide access to an ExampleSet via a ResultSet.

Author:

Ingo Mierswa ingomierswa Exp $

Field Summary

static java.lang.String	PARAMETER_DATAMANAGEMENT The parameter name for "Determines, how the data is represented internally.
static java.lang.String	PARAMETER_ID_ATTRIBUTE The parameter name for "The (case sensitive) name of the id attribute"
static java.lang.String	PARAMETER_LABEL_ATTRIBUTE The parameter name for "The (case sensitive) name of the label attribute"
static java.lang.String	PARAMETER_WEIGHT_ATTRIBUTE The parameter name for "The (case sensitive) name of the weight attribute"

Constructor Summary

ResultSetExampleSource(OperatorDescription description)

Method Summary

ExampleSet	createExampleSet() Creates (or reads) the ExampleSet that will be returned by AbstractReader.apply().
static ExampleSet	createExampleSet(ExampleTable table, Operator operator)
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
abstract java.sql.ResultSet	getResultSet() Returns a ResultSet.
abstract void	setNominalValues(java.util.List<Attribute> attributeList, java.sql.ResultSet resultSet, Attribute label) Since the ResultSet does not provide information about possible values of nominal attributes, subclasses must set these by implementing this method.
abstract void	tearDown() This method is invoked at the end of the data query process.

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_LABEL_ATTRIBUTE

public static final java.lang.String PARAMETER_LABEL_ATTRIBUTE

The parameter name for "The (case sensitive) name of the label attribute"

See Also:

Constant Field Values

PARAMETER_ID_ATTRIBUTE

public static final java.lang.String PARAMETER_ID_ATTRIBUTE

The parameter name for "The (case sensitive) name of the id attribute"

See Also:

Constant Field Values

PARAMETER_WEIGHT_ATTRIBUTE

public static final java.lang.String PARAMETER_WEIGHT_ATTRIBUTE

The parameter name for "The (case sensitive) name of the weight attribute"

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

Constructor Detail

ResultSetExampleSource

public ResultSetExampleSource(OperatorDescription description)

Method Detail

getResultSet

public abstract java.sql.ResultSet getResultSet()
                                         throws OperatorException

Returns a ResultSet.

Throws:

OperatorException

tearDown

public abstract void tearDown()

This method is invoked at the end of the data query process. Subclasses might want to clean up things, e.g. close statements.

setNominalValues

public abstract void setNominalValues(java.util.List<Attribute> attributeList,
                                      java.sql.ResultSet resultSet,
                                      Attribute label)
                               throws OperatorException

Since the ResultSet does not provide information about possible values of nominal attributes, subclasses must set these by implementing this method.

Parameters:

attributeList - List of Attribute

Throws:

OperatorException

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

createExampleSet

public static ExampleSet createExampleSet(ExampleTable table,
                                          Operator operator)
                                   throws OperatorException

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