com.rapidminer.operator.io
Class ExcelExampleSetWriter

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.io.AbstractWriter<ExampleSet>
              com.rapidminer.operator.io.AbstractExampleSetWriter
                  com.rapidminer.operator.io.ExcelExampleSetWriter

All Implemented Interfaces:

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

public class ExcelExampleSetWriter
extends AbstractExampleSetWriter

This operator can be used to write data into Microsoft Excel spreadsheets. This operator creates Excel files readable by Excel 95, 97, 2000, XP, 2003 and newer. Missing data values are indicated by empty cells.

Author:

Ingo Mierswa

Field Summary

static java.lang.String

PARAMETER_EXCEL_FILE The parameter name for "The Excel spreadsheet file which should be written.

Constructor Summary

ExcelExampleSetWriter(OperatorDescription description)

Method Summary

java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
ExampleSet	write(ExampleSet exampleSet) Creates (or reads) the ExampleSet that will be returned by Operator.apply().
static void	write(ExampleSet exampleSet, java.nio.charset.Charset encoding, java.io.OutputStream out)

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

doWork, 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, registerOperator, 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_EXCEL_FILE

public static final java.lang.String PARAMETER_EXCEL_FILE

The parameter name for "The Excel spreadsheet file which should be written."

See Also:

Constant Field Values

Constructor Detail

ExcelExampleSetWriter

public ExcelExampleSetWriter(OperatorDescription description)

Method Detail

write

public ExampleSet write(ExampleSet exampleSet)
                 throws OperatorException

Description copied from class: AbstractWriter

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

Specified by:

write in class AbstractWriter<ExampleSet>

Returns:

the written IOObject itself

Throws:

OperatorException

write

public static void write(ExampleSet exampleSet,
                         java.nio.charset.Charset encoding,
                         java.io.OutputStream out)
                  throws java.io.IOException,
                         jxl.write.WriteException

Throws:

java.io.IOException

jxl.write.WriteException

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