Package weka.core.converters
Class XRFFSaver
- java.lang.Object
-
- weka.core.converters.AbstractSaver
-
- weka.core.converters.AbstractFileSaver
-
- weka.core.converters.XRFFSaver
-
- All Implemented Interfaces:
java.io.Serializable
,CapabilitiesHandler
,BatchConverter
,FileSourcedConverter
,Saver
,EnvironmentHandler
,OptionHandler
,RevisionHandler
public class XRFFSaver extends AbstractFileSaver implements BatchConverter
Writes to a destination that is in the XML version of the ARFF format. The data can be compressed with gzip, in order to save space. Valid options are:-i <the input file> The input file
-o <the output file> The output file
-C <class index> The class index (first and last are valid as well). (default: last)
-compress Compresses the data (uses '.xrff.gz' as extension instead of '.xrff') (default: off)
- Version:
- $Revision: 1.5 $
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
Saver
, Serialized Form
-
-
Field Summary
-
Fields inherited from interface weka.core.converters.Saver
BATCH, INCREMENTAL, NONE
-
-
Constructor Summary
Constructors Constructor Description XRFFSaver()
Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
classIndexTipText()
Returns the tip text for this propertyjava.lang.String
compressOutputTipText()
Returns the tip text for this propertyCapabilities
getCapabilities()
Returns the Capabilities of this saver.java.lang.String
getClassIndex()
Get the index of the class attribute.boolean
getCompressOutput()
Gets whether the output data is compressed.java.lang.String
getFileDescription()
Returns a description of the file type.java.lang.String[]
getFileExtensions()
Gets all the file extensions used for this type of filejava.lang.String[]
getOptions()
returns the options of the current setupjava.lang.String
getRevision()
Returns the revision string.java.lang.String
globalInfo()
Returns a string describing this Saverjava.util.Enumeration
listOptions()
Returns an enumeration describing the available options.static void
main(java.lang.String[] args)
Main method.void
resetOptions()
Resets the Savervoid
setClassIndex(java.lang.String value)
Sets index of the class attribute.void
setCompressOutput(boolean value)
Sets whether to compress the output.void
setDestination(java.io.OutputStream output)
Sets the destination output stream.void
setFile(java.io.File outputFile)
Sets the destination file.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-
Methods inherited from class weka.core.converters.AbstractFileSaver
cancel, filePrefix, getFileExtension, getUseRelativePath, getWriter, resetWriter, retrieveDir, retrieveFile, runFileSaver, setDestination, setDir, setDirAndPrefix, setEnvironment, setFilePrefix, setUseRelativePath, useRelativePathTipText
-
Methods inherited from class weka.core.converters.AbstractSaver
getInstances, getWriteMode, resetStructure, setRetrieval, setStructure, writeIncremental
-
-
-
-
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 interfaceOptionHandler
- Overrides:
listOptions
in classAbstractFileSaver
- 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 interfaceOptionHandler
- Overrides:
getOptions
in classAbstractFileSaver
- 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 (first and last are valid as well). (default: last)
-compress Compresses the data (uses '.xrff.gz' as extension instead of '.xrff') (default: off)
- Specified by:
setOptions
in interfaceOptionHandler
- Overrides:
setOptions
in classAbstractFileSaver
- 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 interfaceFileSourcedConverter
- Specified by:
getFileDescription
in classAbstractFileSaver
- Returns:
- a short file description
-
getFileExtensions
public java.lang.String[] getFileExtensions()
Gets all the file extensions used for this type of file- Specified by:
getFileExtensions
in interfaceFileSourcedConverter
- Overrides:
getFileExtensions
in classAbstractFileSaver
- Returns:
- the file extensions
-
setFile
public void setFile(java.io.File outputFile) throws java.io.IOException
Sets the destination file.- Specified by:
setFile
in interfaceFileSourcedConverter
- Specified by:
setFile
in interfaceSaver
- Overrides:
setFile
in classAbstractFileSaver
- Parameters:
outputFile
- the destination file.- Throws:
java.io.IOException
- throws an IOException if file cannot be set
-
resetOptions
public void resetOptions()
Resets the Saver- Overrides:
resetOptions
in classAbstractFileSaver
-
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
-
compressOutputTipText
public java.lang.String compressOutputTipText()
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getCompressOutput
public boolean getCompressOutput()
Gets whether the output data is compressed.- Returns:
- true if the output data is compressed
-
setCompressOutput
public void setCompressOutput(boolean value)
Sets whether to compress the output.- Parameters:
value
- if truee the output will be compressed
-
getCapabilities
public Capabilities getCapabilities()
Returns the Capabilities of this saver.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classAbstractSaver
- 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 interfaceSaver
- Overrides:
setInstances
in classAbstractSaver
- Parameters:
instances
- the instances
-
setDestination
public void setDestination(java.io.OutputStream output) throws java.io.IOException
Sets the destination output stream.- Specified by:
setDestination
in interfaceSaver
- Overrides:
setDestination
in classAbstractFileSaver
- Parameters:
output
- the output stream.- Throws:
java.io.IOException
- throws an IOException if destination cannot be set
-
writeBatch
public void writeBatch() throws java.io.IOException
Writes a Batch of instances- Specified by:
writeBatch
in interfaceSaver
- Specified by:
writeBatch
in classAbstractSaver
- Throws:
java.io.IOException
- throws IOException if saving in batch mode is not possible
-
getRevision
public java.lang.String getRevision()
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Returns:
- the revision
-
main
public static void main(java.lang.String[] args)
Main method.- Parameters:
args
- should contain the options of a Saver.
-
-