weka.core.converters
Class ArffSaver

java.lang.Object
  extended by weka.core.converters.AbstractSaver
      extended by weka.core.converters.AbstractFileSaver
          extended by weka.core.converters.ArffSaver
All Implemented Interfaces:
java.io.Serializable, CapabilitiesHandler, BatchConverter, FileSourcedConverter, IncrementalConverter, Saver, OptionHandler

public class ArffSaver
extends AbstractFileSaver
implements BatchConverter, IncrementalConverter

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

Version:
$Revision: 1.7 $
Author:
Stefan Mutter (mutter@cs.waikato.ac.nz)
See Also:
Saver, Serialized Form

Field Summary
 
Fields inherited from interface weka.core.converters.Saver
BATCH, INCREMENTAL, NONE
 
Constructor Summary
ArffSaver()
          Constructor
 
Method Summary
 Capabilities getCapabilities()
          Returns the Capabilities of this saver.
 java.lang.String getFileDescription()
          Returns a description of the file type.
 java.lang.String globalInfo()
          Returns a string describing this Saver
static void main(java.lang.String[] args)
          Main method.
 void resetOptions()
          Resets the Saver
 void writeBatch()
          Writes a Batch of instances
 void writeIncremental(Instance inst)
          Saves an instances incrementally.
 
Methods inherited from class weka.core.converters.AbstractFileSaver
cancel, filePrefix, getFileExtension, getFileExtensions, getOptions, getWriter, listOptions, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDestination, setDir, setDirAndPrefix, setFile, setFilePrefix, setOptions
 
Methods inherited from class weka.core.converters.AbstractSaver
getInstances, getWriteMode, resetStructure, setInstances, setRetrieval, setStructure
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArffSaver

public ArffSaver()
Constructor

Method Detail

globalInfo

public java.lang.String globalInfo()
Returns a string describing this Saver

Returns:
a description of the Saver suitable for displaying in the explorer/experimenter gui

getFileDescription

public java.lang.String getFileDescription()
Returns a description of the file type.

Specified by:
getFileDescription in interface FileSourcedConverter
Specified by:
getFileDescription in class AbstractFileSaver
Returns:
a short file description

resetOptions

public void resetOptions()
Resets the Saver

Overrides:
resetOptions in class AbstractFileSaver

getCapabilities

public Capabilities getCapabilities()
Returns the Capabilities of this saver.

Specified by:
getCapabilities in interface CapabilitiesHandler
Overrides:
getCapabilities in class AbstractSaver
Returns:
the capabilities of this object
See Also:
Capabilities

writeIncremental

public void writeIncremental(Instance inst)
                      throws java.io.IOException
Saves an instances incrementally. Structure has to be set by using the setStructure() method or setInstances() method.

Specified by:
writeIncremental in interface Saver
Overrides:
writeIncremental in class AbstractSaver
Parameters:
inst - the instance to save
Throws:
java.io.IOException - throws IOEXception if an instance cannot be saved incrementally.

writeBatch

public void writeBatch()
                throws java.io.IOException
Writes a Batch of instances

Specified by:
writeBatch in interface Saver
Specified by:
writeBatch in class AbstractSaver
Throws:
java.io.IOException - throws IOException if saving in batch mode is not possible

main

public static void main(java.lang.String[] args)
Main method.

Parameters:
args - should contain the options of a Saver.