com.rapidminer.operator.io
Class CSVExampleSetWriter

java.lang.Object
  extended by com.rapidminer.operator.Operator
      extended by com.rapidminer.operator.io.AbstractWriter<ExampleSet>
          extended by com.rapidminer.operator.io.AbstractExampleSetWriter
              extended by com.rapidminer.operator.io.CSVExampleSetWriter
All Implemented Interfaces:
ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class CSVExampleSetWriter
extends AbstractExampleSetWriter

This operator can be used to write data into CSV files (Comma Separated Values). The values and columns are separated by ";". Missing data values are indicated by empty cells.

Author:
Ingo Mierswa

Field Summary
static java.lang.String PARAMETER_COLUMN_SEPARATOR
          The parameter name for the column separator parameter.
static java.lang.String PARAMETER_CSV_FILE
          The parameter name for "The CSV file which should be written.
static java.lang.String PARAMETER_QUOTE_NOMINAL_VALUES
          Indicates if nominal values should be quoted with double quotes.
static java.lang.String PARAMETER_WRITE_ATTRIBUTE_NAMES
          Indicates if the attribute names should be written as first row.
 
Constructor Summary
CSVExampleSetWriter(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_CSV_FILE

public static final java.lang.String PARAMETER_CSV_FILE
The parameter name for "The CSV file which should be written."

See Also:
Constant Field Values

PARAMETER_COLUMN_SEPARATOR

public static final java.lang.String PARAMETER_COLUMN_SEPARATOR
The parameter name for the column separator parameter.

See Also:
Constant Field Values

PARAMETER_WRITE_ATTRIBUTE_NAMES

public static final java.lang.String PARAMETER_WRITE_ATTRIBUTE_NAMES
Indicates if the attribute names should be written as first row.

See Also:
Constant Field Values

PARAMETER_QUOTE_NOMINAL_VALUES

public static final java.lang.String PARAMETER_QUOTE_NOMINAL_VALUES
Indicates if nominal values should be quoted with double quotes. Quotes inside of nominal values will be escaped by a backslash.

See Also:
Constant Field Values
Constructor Detail

CSVExampleSetWriter

public CSVExampleSetWriter(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


Copyright © 2001-2009 by Rapid-I