Package weka.core.converters
Class ArffSaver
java.lang.Object
weka.core.converters.AbstractSaver
weka.core.converters.AbstractFileSaver
weka.core.converters.ArffSaver
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,BatchConverter,FileSourcedConverter,IncrementalConverter,Saver,EnvironmentHandler,OptionHandler,RevisionHandler,WeightedInstancesHandler
public class ArffSaver
extends AbstractFileSaver
implements BatchConverter, IncrementalConverter, WeightedInstancesHandler
Writes to a destination in arff text format.
Valid options are:
-i <the input file> The input file
-o <the output file> The output file
-compress Compresses the data (uses '.arff.gz' as extension instead of '.arff') (default: off)
-decimal <num> The maximum number of digits to print after the decimal place for numeric values (default: 6)
- Version:
- $Revision: 14860 $
- 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 propertyReturns the Capabilities of this saver.booleanGets whether the output data is compressed.Returns a description of the file type.String[]Gets all the file extensions used for this type of fileintGet the maximum number of decimal places to printString[]returns the options of the current setupReturns the revision string.Returns a string describing this SaverReturns an enumeration describing the available options.static voidMain method.Returns the tip text for this property.voidResets the SavervoidsetCompressOutput(boolean value) Sets whether to compress the output.voidsetDestination(OutputStream output) Sets the destination output stream.voidSets the destination file.voidsetMaxDecimalPlaces(int maxDecimal) Set the maximum number of decimal places to printvoidsetOptions(String[] options) Parses the options for this object.voidWrites a Batch of instancesvoidwriteIncremental(Instance inst) Saves an instances incrementally.Methods inherited from class weka.core.converters.AbstractFileSaver
cancel, filePrefix, getFileExtension, getUseRelativePath, getWriter, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDir, setDirAndPrefix, setEnvironment, setFilePrefix, setUseRelativePath, useRelativePathTipTextMethods inherited from class weka.core.converters.AbstractSaver
doNotCheckCapabilitiesTipText, getDoNotCheckCapabilities, getInstances, getWriteMode, resetStructure, setDoNotCheckCapabilities, setInstances, setRetrieval, setStructure
-
Constructor Details
-
ArffSaver
public ArffSaver()Constructor
-
-
Method Details
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classAbstractFileSaver- Returns:
- an enumeration of all the available options.
-
getOptions
returns the options of the current setup- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classAbstractFileSaver- Returns:
- the current options
-
setOptions
Parses the options for this object. Valid options are:-i <the input file> The input file
-o <the output file> The output file
-compress Compresses the data (uses '.arff.gz' as extension instead of '.arff') (default: off)
-decimal <num> The maximum number of digits to print after the decimal place for numeric values (default: 6)
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classAbstractFileSaver- Parameters:
options- the options to use- Throws:
Exception- if setting of options fails
-
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
-
compressOutputTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getCompressOutput
public boolean getCompressOutput()Gets whether the output data is compressed.- Returns:
- true if the output data is compressed
-
setCompressOutput
public void setCompressOutput(boolean value) Sets whether to compress the output.- Parameters:
value- if truee the output will be compressed
-
globalInfo
Returns a string describing this Saver- Returns:
- a description of the Saver 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
-
getFileExtensions
Gets all the file extensions used for this type of file- Specified by:
getFileExtensionsin interfaceFileSourcedConverter- Overrides:
getFileExtensionsin classAbstractFileSaver- Returns:
- the file extensions
-
setFile
Sets the destination file.- Specified by:
setFilein interfaceFileSourcedConverter- Specified by:
setFilein interfaceSaver- Overrides:
setFilein classAbstractFileSaver- Parameters:
outputFile- the destination file.- Throws:
IOException- throws an IOException if file cannot be set
-
setDestination
Sets the destination output stream.- Specified by:
setDestinationin interfaceSaver- Overrides:
setDestinationin classAbstractFileSaver- Parameters:
output- the output stream.- Throws:
IOException- throws an IOException if destination cannot be set
-
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.
-