com.rapidminer.operator.io
Class AbstractReader<T extends IOObject>

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.io.AbstractReader<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractExampleSource, AbstractModelLoader, AttributeWeightsLoader, ClusterModelReader, IOObjectReader, ParameterSetLoader, PerformanceLoader, RepositorySource, ThresholdCreator, ThresholdLoader

public abstract class AbstractReader<T extends IOObject>
extends Operator

Superclass of all operators that have no input and generate a single output. This class is mainly a tribute to the e-LICO DMO.

Author:

Simon Fischer

Nested Class Summary

static class

AbstractReader.ReaderDescription Describes an operator that can read certain file types.

Constructor Summary

AbstractReader(OperatorDescription description, java.lang.Class<? extends IOObject> generatedClass)

Method Summary

protected void	addAnnotations(T result)
static boolean	canMakeReaderFor(java.net.URL url)
static AbstractReader	createReader(java.net.URL url)
void	doWork() Performs the actual work of the operator and must be implemented by subclasses.
static java.lang.String	getFileParameterForOperator(Operator operator) Returns the key of the parameter that specifies the file to be read.
MetaData	getGeneratedMetaData()
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
protected boolean	isMetaDataCacheable()
abstract T	read() Creates (or reads) the ExampleSet that will be returned by Operator.apply().
protected void	registerOperator(Process process) Registers this operator in the given process.
protected static void	registerReaderDescription(AbstractReader.ReaderDescription rd) Registers an operator that can read files with a given extension.
protected boolean	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

Constructor Detail

AbstractReader

public AbstractReader(OperatorDescription description,
                      java.lang.Class<? extends IOObject> generatedClass)

Method Detail

getGeneratedMetaData

public MetaData getGeneratedMetaData()
                              throws OperatorException

Throws:

OperatorException

isMetaDataCacheable

protected boolean isMetaDataCacheable()

read

public abstract T read()
                                 throws OperatorException

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

Throws:

OperatorException

doWork

public void doWork()
            throws OperatorException

Description copied from class: Operator

Performs the actual work of the operator and must be implemented by subclasses. Replaces the old method apply().

Overrides:

doWork in class Operator

Throws:

OperatorException

addAnnotations

protected void addAnnotations(T result)

registerReaderDescription

protected static void registerReaderDescription(AbstractReader.ReaderDescription rd)

Registers an operator that can read files with a given extension.

createReader

public static AbstractReader createReader(java.net.URL url)
                                   throws OperatorCreationException

Throws:

OperatorCreationException

canMakeReaderFor

public static boolean canMakeReaderFor(java.net.URL url)

getFileParameterForOperator

public static java.lang.String getFileParameterForOperator(Operator operator)

Returns the key of the parameter that specifies the file to be read.

registerOperator

protected void registerOperator(Process process)

Description copied from class: Operator

Registers this operator in the given process. Please note that this might change the name of the operator.

Overrides:

registerOperator in class Operator

supportsEncoding

protected boolean supportsEncoding()

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 Operator