weka.core.converters
Class LibSVMSaver

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

public class LibSVMSaver
extends AbstractFileSaver
implements BatchConverter, IncrementalConverter

Writes to a destination that is in libsvm format.

For more information about libsvm see:

http://www.csie.ntu.edu.tw/~cjlin/libsvm/

Valid options are:

 -i <the input file>
  The input file
 -o <the output file>
  The output file
 -c <class index>
  The class index
  (default: last)

Version:
$Revision: 1.3 $
Author:
FracPete (fracpete at waikato dot ac dot nz)
See Also:
Saver, Serialized Form

Field Summary
static java.lang.String FILE_EXTENSION
          the file extension
 
Fields inherited from interface weka.core.converters.Saver
BATCH, INCREMENTAL, NONE
 
Constructor Summary
LibSVMSaver()
          Constructor
 
Method Summary
 java.lang.String classIndexTipText()
          Returns the tip text for this property
 Capabilities getCapabilities()
          Returns the Capabilities of this saver.
 java.lang.String getClassIndex()
          Get the index of the class attribute.
 java.lang.String getFileDescription()
          Returns a description of the file type.
 java.lang.String[] getOptions()
          returns the options of the current setup
 java.lang.String globalInfo()
          Returns a string describing this Saver
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
static void main(java.lang.String[] args)
          Main method.
 void resetOptions()
          Resets the Saver
 void setClassIndex(java.lang.String value)
          Sets index of the class attribute.
 void setInstances(Instances instances)
          Sets instances that should be stored.
 void setOptions(java.lang.String[] options)
          Parses the options for this object.
 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, getWriter, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDestination, setDir, setDirAndPrefix, setFile, setFilePrefix
 
Methods inherited from class weka.core.converters.AbstractSaver
getInstances, getWriteMode, resetStructure, setRetrieval, setStructure
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FILE_EXTENSION

public static java.lang.String FILE_EXTENSION
the file extension

Constructor Detail

LibSVMSaver

public LibSVMSaver()
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

listOptions

public java.util.Enumeration listOptions()
Returns an enumeration describing the available options.

Specified by:
listOptions in interface OptionHandler
Overrides:
listOptions in class AbstractFileSaver
Returns:
an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()
returns the options of the current setup

Specified by:
getOptions in interface OptionHandler
Overrides:
getOptions in class AbstractFileSaver
Returns:
the current options

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
Parses the options for this object.

Valid options are:

 -i <the input file>
  The input file
 -o <the output file>
  The output file
 -c <class index>
  The class index
  (default: last)

Specified by:
setOptions in interface OptionHandler
Overrides:
setOptions in class AbstractFileSaver
Parameters:
options - the options to use
Throws:
java.lang.Exception - if setting of options fails

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

classIndexTipText

public java.lang.String classIndexTipText()
Returns the tip text for this property

Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui

getClassIndex

public java.lang.String getClassIndex()
Get the index of the class attribute.

Returns:
the index of the class attribute

setClassIndex

public void setClassIndex(java.lang.String value)
Sets index of the class attribute.

Parameters:
value - the index of the class attribute

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

setInstances

public void setInstances(Instances instances)
Sets instances that should be stored.

Specified by:
setInstances in interface Saver
Overrides:
setInstances in class AbstractSaver
Parameters:
instances - the instances

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.