Package weka.core.converters

Class SimpleArffSaver

java.lang.Object

weka.core.converters.AbstractSaver

weka.core.converters.AbstractFileSaver

weka.core.converters.SimpleArffSaver

All Implemented Interfaces:

EncodingSupporter, Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.converters.BatchConverter, weka.core.converters.FileSourcedConverter, weka.core.converters.Saver, weka.core.EnvironmentHandler, weka.core.OptionHandler, weka.core.RevisionHandler, weka.core.WeightedInstancesHandler

public class SimpleArffSaver
extends weka.core.converters.AbstractFileSaver
implements weka.core.converters.BatchConverter, weka.core.WeightedInstancesHandler, EncodingSupporter

Writes the Instances to an ARFF file in batch mode.

Valid options are:

 -i <the input file>
  The input file

 -o <the output file>
  The output file

 -decimal <num>
  The maximum number of digits to print after the decimal
  place for numeric values (default: 6)

 -encoding <charset>
  Character set to use for writing the file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Saver, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_DECIMAL_PLACES	the default number of decimal places.
protected BaseCharset	m_Encoding	the encoding to use.
protected int	m_MaxDecimalPlaces	Max number of decimal places for numeric values
protected File	m_OutputFile	the file to write to.

Fields inherited from class weka.core.converters.AbstractFileSaver

m_env, m_incrementalCounter, m_useRelativePath

Fields inherited from class weka.core.converters.AbstractSaver

CANCEL, m_DoNotCheckCapabilities, m_retrieval, STRUCTURE_READY, WAIT, WRITE

Fields inherited from interface weka.core.converters.Saver

BATCH, INCREMENTAL, NONE

Constructor Summary

Constructors

Constructor	Description
SimpleArffSaver()	Constructor

Method Summary

Modifier and Type	Method	Description
String	encodingTipText()	Returns the tip text for this property.
weka.core.Capabilities	getCapabilities()	Returns the Capabilities of this saver.
BaseCharset	getEncoding()	Returns the encoding to use.
String	getFileDescription()	Returns a description of the file type.
String[]	getFileExtensions()	Gets all the file extensions used for this type of file
int	getMaxDecimalPlaces()	Returns the maximum number of decimal places to print
String[]	getOptions()	returns the options of the current setup
String	getRevision()	Returns the revision string.
String	globalInfo()	Returns a string describing this Saver
Enumeration	listOptions()	Returns an enumeration describing the available options.
static void	main(String[] args)	Main method.
String	maxDecimalPlacesTipText()	Returns the tip text for this property.
void	resetOptions()
void	setDestination(File file)	Sets the destination file (and directories if necessary).
void	setDestination(OutputStream output)	Default implementation throws an IOException.
void	setEncoding(BaseCharset value)	Sets the encoding to use.
void	setMaxDecimalPlaces(int value)	Set the maximum number of decimal places to print
void	setOptions(String[] options)	Parses the options for this object.
void	writeBatch()	Writes a Batch of instances

Methods inherited from class weka.core.converters.AbstractFileSaver

cancel, filePrefix, getFileExtension, getUseRelativePath, getWriter, makeOptionStr, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDir, setDirAndPrefix, setEnvironment, setFile, setFileExtension, setFilePrefix, setUseRelativePath, useRelativePathTipText

Methods inherited from class weka.core.converters.AbstractSaver

doNotCheckCapabilitiesTipText, getDoNotCheckCapabilities, getInstances, getRetrieval, getWriteMode, resetStructure, setDoNotCheckCapabilities, setInstances, setRetrieval, setStructure, setWriteMode, writeIncremental

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_DECIMAL_PLACES

public static final int DEFAULT_MAX_DECIMAL_PLACES

the default number of decimal places.

See Also:

Constant Field Values

m_OutputFile

protected File m_OutputFile

the file to write to.

m_MaxDecimalPlaces

protected int m_MaxDecimalPlaces

Max number of decimal places for numeric values

m_Encoding

protected BaseCharset m_Encoding

the encoding to use.

Constructor Detail

SimpleArffSaver

public SimpleArffSaver()

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 weka.core.OptionHandler

Overrides:

listOptions in class weka.core.converters.AbstractFileSaver

Returns:

an enumeration of all the available options.

resetOptions

public void resetOptions()

Overrides:

resetOptions in class weka.core.converters.AbstractFileSaver

getOptions

public String[] getOptions()

returns the options of the current setup

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class weka.core.converters.AbstractFileSaver

Returns:

the current options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses the options for this object.

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.core.converters.AbstractFileSaver

Parameters:

options - the options to use

Throws:

Exception - if setting of options fails

setMaxDecimalPlaces

public void setMaxDecimalPlaces(int value)

Set the maximum number of decimal places to print

Parameters:

value - the maximum number of decimal places to print

getMaxDecimalPlaces

public int getMaxDecimalPlaces()

Returns the maximum number of decimal places to print

Returns:

the maximum number of decimal places to print

maxDecimalPlacesTipText

public String maxDecimalPlacesTipText()

Returns the tip text for this property.

Returns:

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

setEncoding

public void setEncoding(BaseCharset value)

Sets the encoding to use.

Specified by:

setEncoding in interface EncodingSupporter

Parameters:

value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

getEncoding

public BaseCharset getEncoding()

Returns the encoding to use.

Specified by:

getEncoding in interface EncodingSupporter

Returns:

the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

encodingTipText

public String encodingTipText()

Returns the tip text for this property.

Specified by:

encodingTipText in interface EncodingSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getFileDescription

public String getFileDescription()

Returns a description of the file type.

Specified by:

getFileDescription in interface weka.core.converters.FileSourcedConverter

Specified by:

getFileDescription in class weka.core.converters.AbstractFileSaver

Returns:

a short file description

getFileExtensions

public String[] getFileExtensions()

Gets all the file extensions used for this type of file

Specified by:

getFileExtensions in interface weka.core.converters.FileSourcedConverter

Overrides:

getFileExtensions in class weka.core.converters.AbstractFileSaver

Returns:

the file extensions

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this saver.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.core.converters.AbstractSaver

Returns:

the capabilities of this object

See Also:

Capabilities

setDestination

public void setDestination(File file)
                    throws IOException

Sets the destination file (and directories if necessary).

Specified by:

setDestination in interface weka.core.converters.Saver

Overrides:

setDestination in class weka.core.converters.AbstractFileSaver

Parameters:

file - the File

Throws:

IOException - always

setDestination

public void setDestination(OutputStream output)
                    throws IOException

Default implementation throws an IOException.

Specified by:

setDestination in interface weka.core.converters.Saver

Overrides:

setDestination in class weka.core.converters.AbstractFileSaver

Parameters:

output - the OutputStream

Throws:

IOException - always

writeBatch

public void writeBatch()
                throws IOException

Writes a Batch of instances

Specified by:

writeBatch in interface weka.core.converters.Saver

Specified by:

writeBatch in class weka.core.converters.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 weka.core.RevisionHandler

Returns:

the revision

main

public static void main(String[] args)
                 throws Exception

Main method.

Parameters:

args - should contain the options of a Saver.

Throws:

Exception