Class SVMLightSaver

All Implemented Interfaces:
Serializable, CapabilitiesHandler, CapabilitiesIgnorer, BatchConverter, FileSourcedConverter, IncrementalConverter, Saver, EnvironmentHandler, OptionHandler, RevisionHandler

public class SVMLightSaver extends AbstractFileSaver implements BatchConverter, IncrementalConverter
Writes to a destination that is in svm light format.

For more information about svm light see:

http://svmlight.joachims.org/

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: 10203 $
Author:
FracPete (fracpete at waikato dot ac dot nz)
See Also:
  • Field Details

    • FILE_EXTENSION

      public static String FILE_EXTENSION
      the file extension.
    • MAX_DIGITS

      public static int MAX_DIGITS
      the number of digits after the decimal point.
  • Constructor Details

    • SVMLightSaver

      public SVMLightSaver()
      Constructor.
  • Method Details

    • globalInfo

      public String globalInfo()
      Returns a string describing this Saver.
      Returns:
      a description of the Saver suitable for displaying in the explorer/experimenter gui
    • listOptions

      public Enumeration<Option> 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 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(String[] options) throws 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:
      Exception - if setting of options fails
    • getFileDescription

      public 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 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 String getClassIndex()
      Get the index of the class attribute.
      Returns:
      the index of the class attribute
    • setClassIndex

      public void setClassIndex(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:
    • 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 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:
      IOException - throws IOEXception if an instance cannot be saved incrementally.
    • writeBatch

      public void writeBatch() throws IOException
      Writes a Batch of instances.
      Specified by:
      writeBatch in interface Saver
      Specified by:
      writeBatch in class AbstractSaver
      Throws:
      IOException - throws IOException if saving in batch mode is not possible
    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Returns:
      the revision
    • main

      public static void main(String[] args)
      Main method.
      Parameters:
      args - should contain the options of a Saver.