com.rapidminer.operator.io
Class IOContainerReader

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.io.IOContainerReader

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class IOContainerReader
extends Operator

Reads all elements of an IOContainer from a file. The file must be written by an IOContainerWriter. The operator additionally supports to read text from a logfile, which will be given to the RapidMiner LogService. Hence, if you add a IOContainerWriter to the end of an process and set the logfile in the process root operator, the output of applying the IOContainerReader will be quite similar to what the original process displayed.

Author:

Stefan Rueping, Ingo Mierswa

See Also:

IOContainer

Field Summary

static int	APPEND
static java.lang.String[]	METHODS
static java.lang.String	PARAMETER_FILENAME The parameter name for "Name of file to write the output to.
static java.lang.String	PARAMETER_LOGFILE The parameter name for "Name of file to read log information from (optional).
static java.lang.String	PARAMETER_METHOD The parameter name for "Append or prepend the contents of the file to this operators input or replace this operators input?
static int	PREPEND
static int	REPLACE

Constructor Summary

IOContainerReader(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

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_FILENAME

public static final java.lang.String PARAMETER_FILENAME

The parameter name for "Name of file to write the output to."

See Also:

Constant Field Values

PARAMETER_METHOD

public static final java.lang.String PARAMETER_METHOD

The parameter name for "Append or prepend the contents of the file to this operators input or replace this operators input?"

See Also:

Constant Field Values

PARAMETER_LOGFILE

public static final java.lang.String PARAMETER_LOGFILE

The parameter name for "Name of file to read log information from (optional)."

See Also:

Constant Field Values

METHODS

public static final java.lang.String[] METHODS

APPEND

public static final int APPEND

See Also:

Constant Field Values

PREPEND

public static final int PREPEND

See Also:

Constant Field Values

REPLACE

public static final int REPLACE

See Also:

Constant Field Values

Constructor Detail

IOContainerReader

public IOContainerReader(OperatorDescription description)

Method Detail

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

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