Package weka.core.converters
Class CSVSaver
java.lang.Object
weka.core.converters.AbstractSaver
weka.core.converters.AbstractFileSaver
weka.core.converters.CSVSaver
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,BatchConverter,FileSourcedConverter,IncrementalConverter,Saver,EnvironmentHandler,OptionHandler,RevisionHandler
public class CSVSaver
extends AbstractFileSaver
implements BatchConverter, IncrementalConverter, FileSourcedConverter
Writes to a destination that is in CSV
(comma-separated values) format. The column separator can be chosen (default
is ',') as well as the value representing missing values (default is '?').
Valid options are:
-F <separator> The field separator to be used. '\t' can be used as well. (default: ',')
-M <str> The string representing a missing value. (default: ?)
-N Don't write a header row.
-decimal <num> The maximum number of digits to print after the decimal place for numeric values (default: 6)
-i <the input file> The input file
-o <the output file> The output file
- Version:
- $Revision: 10203 $
- Author:
- Stefan Mutter (mutter@cs.waikato.ac.nz)
- See Also:
-
Field Summary
Fields inherited from interface weka.core.converters.Saver
BATCH, INCREMENTAL, NONE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this property.Returns the Capabilities of this saver.Returns the character used as column separator.Returns a description of the file type.intGet the maximum number of decimal places to printReturns the current placeholder for missing values.booleanGet whether to not write the header rowString[]Gets the current settings of the Classifier.Returns the revision string.Returns a string describing this Saver.Returns an enumeration describing the available options.static voidMain method.Returns the tip text for this property.Returns the tip text for this property.Returns the tip text for this property.voidResets the Saver.voidsetFieldSeparator(String value) Sets the character used as column separator.voidsetMaxDecimalPlaces(int maxDecimal) Set the maximum number of decimal places to printvoidsetMissingValue(String value) Sets the placeholder for missing values.voidsetNoHeaderRow(boolean b) Set whether to not write the header rowvoidsetOptions(String[] options) Valid options are:voidWrites a Batch of instances.voidwriteIncremental(Instance inst) Saves an instances incrementally.Methods inherited from class weka.core.converters.AbstractFileSaver
cancel, filePrefix, getFileExtension, getFileExtensions, getUseRelativePath, getWriter, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDestination, setDir, setDirAndPrefix, setEnvironment, setFile, setFilePrefix, setUseRelativePath, useRelativePathTipTextMethods inherited from class weka.core.converters.AbstractSaver
doNotCheckCapabilitiesTipText, getDoNotCheckCapabilities, getInstances, getWriteMode, resetStructure, setDoNotCheckCapabilities, setInstances, setRetrieval, setStructureMethods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface weka.core.converters.FileSourcedConverter
getFileExtension, getFileExtensions, getUseRelativePath, retrieveFile, setFile, setUseRelativePath
-
Constructor Details
-
CSVSaver
public CSVSaver()Constructor.
-
-
Method Details
-
globalInfo
Returns a string describing this Saver.- Returns:
- a description of the Saver suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classAbstractFileSaver- Returns:
- an enumeration of all the available options.
-
setOptions
Valid options are:-F <separator> The field separator to be used. '\t' can be used as well. (default: ',')
-M <str> The string representing a missing value. (default: ?)
-N Don't write a header row.
-decimal <num> The maximum number of digits to print after the decimal place for numeric values (default: 6)
-i <the input file> The input file
-o <the output file> The output file
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classAbstractFileSaver- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the Classifier.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classAbstractFileSaver- Returns:
- an array of strings suitable for passing to setOptions
-
noHeaderRowTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setNoHeaderRow
public void setNoHeaderRow(boolean b) Set whether to not write the header row- Parameters:
b- true if no header row is to be written
-
getNoHeaderRow
public boolean getNoHeaderRow()Get whether to not write the header row- Returns:
- true if no header row is to be written
-
setMaxDecimalPlaces
public void setMaxDecimalPlaces(int maxDecimal) Set the maximum number of decimal places to print- Parameters:
maxDecimal- the maximum number of decimal places to print
-
getMaxDecimalPlaces
public int getMaxDecimalPlaces()Get the maximum number of decimal places to print- Returns:
- the maximum number of decimal places to print
-
maxDecimalPlacesTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setFieldSeparator
Sets the character used as column separator.- Parameters:
value- the character to use
-
getFieldSeparator
Returns the character used as column separator.- Returns:
- the character to use
-
fieldSeparatorTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setMissingValue
Sets the placeholder for missing values.- Parameters:
value- the placeholder
-
getMissingValue
Returns the current placeholder for missing values.- Returns:
- the placeholder
-
missingValueTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getFileDescription
Returns a description of the file type.- Specified by:
getFileDescriptionin interfaceFileSourcedConverter- Specified by:
getFileDescriptionin classAbstractFileSaver- Returns:
- a short file description
-
resetOptions
public void resetOptions()Resets the Saver.- Overrides:
resetOptionsin classAbstractFileSaver
-
getCapabilities
Returns the Capabilities of this saver.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classAbstractSaver- Returns:
- the capabilities of this object
- See Also:
-
writeIncremental
Saves an instances incrementally. Structure has to be set by using the setStructure() method or setInstances() method.- Specified by:
writeIncrementalin interfaceSaver- Overrides:
writeIncrementalin classAbstractSaver- Parameters:
inst- the instance to save- Throws:
IOException- throws IOEXception if an instance cannot be saved incrementally.
-
writeBatch
Writes a Batch of instances.- Specified by:
writeBatchin interfaceSaver- Specified by:
writeBatchin classAbstractSaver- Throws:
IOException- throws IOException if saving in batch mode is not possible
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Returns:
- the revision
-
main
Main method.- Parameters:
args- should contain the options of a Saver.
-