public abstract class AbstractFileSaver extends AbstractSaver implements OptionHandler, FileSourcedConverter, EnvironmentHandler
-o the output file
The output file. The prefix of the output file is sufficient. If no output file is given, Saver tries to use standard out.
BATCH, INCREMENTAL, NONE
Constructor and Description |
---|
AbstractFileSaver() |
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancels the incremental saving process.
|
java.lang.String |
filePrefix()
Gets the file name prefix
|
abstract java.lang.String |
getFileDescription()
to be pverridden
|
java.lang.String |
getFileExtension()
Gets ihe file extension.
|
java.lang.String[] |
getFileExtensions()
Gets all the file extensions used for this type of file
|
java.lang.String[] |
getOptions()
Gets the current settings of the Saver object.
|
boolean |
getUseRelativePath()
Gets whether relative paths are to be used
|
java.io.BufferedWriter |
getWriter()
Gets the writer
|
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options.
|
void |
resetOptions()
resets the options
|
void |
resetWriter()
Sets the writer to null.
|
java.lang.String |
retrieveDir()
Gets the directory
|
java.io.File |
retrieveFile()
Gets the destination file.
|
static void |
runFileSaver(AbstractFileSaver saver,
java.lang.String[] options)
runs the given saver with the specified options
|
void |
setDestination(java.io.File file)
Sets the destination file (and directories if necessary).
|
void |
setDestination(java.io.OutputStream output)
Sets the destination output stream.
|
void |
setDir(java.lang.String dir)
Sets the directory where the instances should be stored
|
void |
setDirAndPrefix(java.lang.String relationName,
java.lang.String add)
Sets the directory and the file prefix.
|
void |
setEnvironment(Environment env)
Set the environment variables to use.
|
void |
setFile(java.io.File outputFile)
Sets the destination file.
|
void |
setFilePrefix(java.lang.String prefix)
Sets the file name prefix
|
void |
setOptions(java.lang.String[] options)
Parses a given list of options.
|
void |
setUseRelativePath(boolean rp)
Set whether to use relative rather than absolute paths
|
java.lang.String |
useRelativePathTipText()
Tip text suitable for displaying int the GUI
|
getCapabilities, getInstances, getWriteMode, resetStructure, setInstances, setRetrieval, setStructure, writeBatch, writeIncremental
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRevision
public void resetOptions()
resetOptions
in class AbstractSaver
public java.io.BufferedWriter getWriter()
public void resetWriter()
public java.lang.String getFileExtension()
getFileExtension
in interface FileSourcedConverter
getFileExtension
in interface Saver
getFileExtension
in class AbstractSaver
public java.lang.String[] getFileExtensions()
getFileExtensions
in interface FileSourcedConverter
public java.io.File retrieveFile()
retrieveFile
in interface FileSourcedConverter
public void setFile(java.io.File outputFile) throws java.io.IOException
setFile
in interface FileSourcedConverter
setFile
in interface Saver
setFile
in class AbstractSaver
outputFile
- the destination file.java.io.IOException
- throws an IOException if file cannot be setpublic void setFilePrefix(java.lang.String prefix)
setFilePrefix
in interface Saver
setFilePrefix
in class AbstractSaver
prefix
- the file name prefixpublic java.lang.String filePrefix()
filePrefix
in interface Saver
filePrefix
in class AbstractSaver
public void setDir(java.lang.String dir)
setDir
in interface Saver
setDir
in class AbstractSaver
dir
- a string containing the directory path and namepublic java.lang.String retrieveDir()
retrieveDir
in interface Saver
retrieveDir
in class AbstractSaver
public void setEnvironment(Environment env)
setEnvironment
in interface EnvironmentHandler
env
- the environment variables to usepublic java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-i input arff file
The input filw in arff format.
-o the output file
The output file. The prefix of the output file is sufficient. If no output file is given, Saver tries to use standard out.
setOptions
in interface OptionHandler
options
- the list of options as an array of stringsjava.lang.Exception
- if an option is not supportedpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public void cancel()
cancel
in class AbstractSaver
public void setDestination(java.io.File file) throws java.io.IOException
setDestination
in interface Saver
setDestination
in class AbstractSaver
file
- the Filejava.io.IOException
- alwayspublic void setDestination(java.io.OutputStream output) throws java.io.IOException
setDestination
in interface Saver
setDestination
in class AbstractSaver
output
- the output stream.java.io.IOException
- throws an IOException if destination cannot be setpublic void setDirAndPrefix(java.lang.String relationName, java.lang.String add)
setDirAndPrefix
in interface Saver
setDirAndPrefix
in class AbstractSaver
relationName
- the name of the relation to saveadd
- additional string which should be part of the filenamepublic abstract java.lang.String getFileDescription()
getFileDescription
in interface FileSourcedConverter
public java.lang.String useRelativePathTipText()
public void setUseRelativePath(boolean rp)
setUseRelativePath
in interface FileSourcedConverter
rp
- true if relative paths are to be usedpublic boolean getUseRelativePath()
getUseRelativePath
in interface FileSourcedConverter
public static void runFileSaver(AbstractFileSaver saver, java.lang.String[] options)
saver
- the saver to runoptions
- the commandline options