public abstract class AbstractSaver extends Object implements Saver, CapabilitiesHandler
Modifier and Type | Field and Description |
---|---|
protected static int |
CANCEL |
protected int |
m_retrieval
The current retrieval mode
|
protected static int |
STRUCTURE_READY |
protected static int |
WAIT |
protected static int |
WRITE
The write modes
|
BATCH, INCREMENTAL, NONE
Constructor and Description |
---|
AbstractSaver() |
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancels the incremental saving process if the write mode is CANCEL.
|
String |
filePrefix()
Default implementation throws an IOException.
|
Capabilities |
getCapabilities()
Returns the Capabilities of this saver.
|
String |
getFileExtension()
Default implementation throws an IOException.
|
Instances |
getInstances()
Gets instances that should be stored.
|
protected int |
getRetrieval()
Gets the retrieval mode.
|
int |
getWriteMode()
Gets the write mode.
|
void |
resetOptions()
resets the options
|
void |
resetStructure()
Resets the structure (header information of the instances)
|
String |
retrieveDir()
Default implementation throws an IOException.
|
void |
setDestination(File file)
Default implementation throws an IOException.
|
void |
setDestination(OutputStream output)
Default implementation throws an IOException.
|
void |
setDir(String dir)
Default implementation throws an IOException.
|
void |
setDirAndPrefix(String relationName,
String add)
Default implementation throws an IOException.
|
void |
setFile(File file)
Default implementation throws an IOException.
|
void |
setFilePrefix(String prefix)
Default implementation throws an IOException.
|
void |
setInstances(Instances instances)
Sets instances that should be stored.
|
void |
setRetrieval(int mode)
Sets the retrieval mode.
|
int |
setStructure(Instances headerInfo)
Sets the strcuture of the instances for the first step of incremental saving.
|
protected void |
setWriteMode(int mode)
Sets the write mode.
|
abstract void |
writeBatch()
Writes to a file in batch mode
To be overridden.
|
void |
writeIncremental(Instance i)
Method for incremental saving.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRevision
protected static final int WRITE
protected static final int WAIT
protected static final int CANCEL
protected static final int STRUCTURE_READY
protected int m_retrieval
public void resetOptions()
public void resetStructure()
public void setRetrieval(int mode)
setRetrieval
in interface Saver
mode
- the retrieval modeprotected int getRetrieval()
protected void setWriteMode(int mode)
mode
- the write modepublic int getWriteMode()
getWriteMode
in interface Saver
public void setInstances(Instances instances)
setInstances
in interface Saver
instances
- the instancespublic Instances getInstances()
public void setDestination(File file) throws IOException
setDestination
in interface Saver
file
- the FileIOException
- alwayspublic void setDestination(OutputStream output) throws IOException
setDestination
in interface Saver
output
- the OutputStreamIOException
- alwayspublic Capabilities getCapabilities()
getCapabilities
in interface CapabilitiesHandler
Capabilities
public int setStructure(Instances headerInfo)
headerInfo
- an instances object.public void cancel()
public void writeIncremental(Instance i) throws IOException
writeIncremental
in interface Saver
i
- the instance to be savedIOException
- IOEXception if the instance acnnot be written to the specified destinationpublic abstract void writeBatch() throws IOException
writeBatch
in interface Saver
IOException
- exception if writting is not possiblepublic String getFileExtension() throws Exception
getFileExtension
in interface Saver
IOException
- alwaysException
- exception if a Saver not implementing FileSourcedConverter is used.public void setFile(File file) throws IOException
setFile
in interface Saver
file
- the FileIOException
- alwayspublic void setFilePrefix(String prefix) throws Exception
setFilePrefix
in interface Saver
prefix
- the file prefixIOException
- alwaysException
- exception if a Saver not implementing FileSourcedConverter is used.public String filePrefix() throws Exception
filePrefix
in interface Saver
IOException
- alwaysException
- exception if a Saver not implementing FileSourcedConverter is used.public void setDir(String dir) throws IOException
setDir
in interface Saver
dir
- the name of the directory to save inIOException
- alwayspublic void setDirAndPrefix(String relationName, String add) throws IOException
setDirAndPrefix
in interface Saver
relationName
- add
- IOException
- alwayspublic String retrieveDir() throws IOException
retrieveDir
in interface Saver
IOException
- alwaysCopyright © 2015 University of Waikato, Hamilton, NZ. All rights reserved.