weka.core.converters

Class SVMLightSaver

java.lang.Object

weka.core.converters.AbstractSaver

weka.core.converters.AbstractFileSaver

weka.core.converters.SVMLightSaver

All Implemented Interfaces:

Serializable, CapabilitiesHandler, 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: 7950 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Saver, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSION the file extension.
protected SingleIndex	m_ClassIndex the class index.
static int	MAX_DIGITS the number of digits after the decimal point.

Fields inherited from class weka.core.converters.AbstractFileSaver

m_env, m_incrementalCounter, m_useRelativePath

Fields inherited from class weka.core.converters.AbstractSaver

CANCEL, m_retrieval, STRUCTURE_READY, WAIT, WRITE

Fields inherited from interface weka.core.converters.Saver

BATCH, INCREMENTAL, NONE

Constructor Summary

Constructors

Constructor and Description
SVMLightSaver() Constructor.

Method Summary

Modifier and Type	Method and Description
String	classIndexTipText() Returns the tip text for this property.
Capabilities	getCapabilities() Returns the Capabilities of this saver.
String	getClassIndex() Get the index of the class attribute.
String	getFileDescription() Returns a description of the file type.
String[]	getOptions() returns the options of the current setup.
String	getRevision() Returns the revision string.
String	globalInfo() Returns a string describing this Saver.
protected String	instanceToSvmlight(Instance inst) turns the instance into a svm light row.
Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(String[] args) Main method.
void	resetOptions() Resets the Saver.
void	setClassIndex(String value) Sets index of the class attribute.
void	setInstances(Instances instances) Sets instances that should be stored.
void	setOptions(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, getUseRelativePath, getWriter, makeOptionStr, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDestination, setDir, setDirAndPrefix, setEnvironment, setFile, setFileExtension, setFilePrefix, setUseRelativePath, useRelativePathTipText

Methods inherited from class weka.core.converters.AbstractSaver

getInstances, getRetrieval, getWriteMode, resetStructure, setRetrieval, setStructure, setWriteMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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.

m_ClassIndex

protected SingleIndex m_ClassIndex

the class index.

Constructor Detail

SVMLightSaver

public SVMLightSaver()

Constructor.

Method Detail

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 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:

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

instanceToSvmlight

protected String instanceToSvmlight(Instance inst)

turns the instance into a svm light row.

Parameters:

inst - the instance to transform

Returns:

the generated svm light row

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.