com.rapidminer.operator.io
Class XrffExampleSetWriter

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.io.AbstractWriter<ExampleSet>
          com.rapidminer.operator.io.AbstractExampleSetWriter
              com.rapidminer.operator.io.XrffExampleSetWriter

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class XrffExampleSetWriter
extends AbstractExampleSetWriter

Writes values of all examples into an XRFF file which can be used by the machine learning library Weka. The XRFF format is described in the XrffExampleSource operator which is able to read XRFF files to make them usable with RapidMiner.

Please note that writing attribute weights is not supported, please use the other RapidMiner operators for attribute weight loading and writing for this purpose.

Author:

Ingo Mierswa

Keywords:

xrff

Field Summary

static java.lang.String	PARAMETER_COMPRESS The parameter name for "Indicates if the data file should be compressed.
static java.lang.String	PARAMETER_EXAMPLE_SET_FILE The parameter name for "File to save the example set to.

Constructor Summary

XrffExampleSetWriter(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 AbstractWriter.apply().

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

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_EXAMPLE_SET_FILE

public static final java.lang.String PARAMETER_EXAMPLE_SET_FILE

The parameter name for "File to save the example set to."

See Also:

Constant Field Values

PARAMETER_COMPRESS

public static final java.lang.String PARAMETER_COMPRESS

The parameter name for "Indicates if the data file should be compressed."

See Also:

Constant Field Values

Constructor Detail

XrffExampleSetWriter

public XrffExampleSetWriter(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 AbstractWriter.apply().

Specified by:

write in class AbstractWriter<ExampleSet>

Returns:

the written IOObject itself

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