Package weka.core.converters
Class AbstractSaver
java.lang.Object
weka.core.converters.AbstractSaver
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,Saver,RevisionHandler
- Direct Known Subclasses:
AbstractFileSaver,DatabaseSaver
public abstract class AbstractSaver
extends Object
implements Saver, CapabilitiesHandler, CapabilitiesIgnorer
Abstract class for Saver
- Version:
- $Revision: 11006 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz), Stefan Mutter (mutter@cs.waikato.ac.nz)
- See Also:
-
Field Summary
Fields inherited from interface weka.core.converters.Saver
BATCH, INCREMENTAL, NONE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcancel()Cancels the incremental saving process if the write mode is CANCEL.Returns the tip text for this propertyDefault implementation throws an IOException.Returns the Capabilities of this saver.booleanGet whether capabilities checking is turned off.Default implementation throws an IOException.Gets instances that should be stored.intGets the write mode.voidresets the optionsvoidResets the structure (header information of the instances)Default implementation throws an IOException.voidsetDestination(File file) Default implementation throws an IOException.voidsetDestination(OutputStream output) Default implementation throws an IOException.voidDefault implementation throws an IOException.voidsetDirAndPrefix(String relationName, String add) Default implementation throws an IOException.voidsetDoNotCheckCapabilities(boolean doNotCheckCapabilities) Set whether not to check capabilities.voidDefault implementation throws an IOException.voidsetFilePrefix(String prefix) Default implementation throws an IOException.voidsetInstances(Instances instances) Sets instances that should be stored.voidsetRetrieval(int mode) Sets the retrieval mode.intsetStructure(Instances headerInfo) Sets the strcuture of the instances for the first step of incremental saving.abstract voidWrites to a file in batch mode To be overridden.voidMethod for incremental saving.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface weka.core.RevisionHandler
getRevision
-
Constructor Details
-
AbstractSaver
public AbstractSaver()
-
-
Method Details
-
doNotCheckCapabilitiesTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setDoNotCheckCapabilities
public void setDoNotCheckCapabilities(boolean doNotCheckCapabilities) Set whether not to check capabilities.- Specified by:
setDoNotCheckCapabilitiesin interfaceCapabilitiesIgnorer- Parameters:
doNotCheckCapabilities- true if capabilities are not to be checked.
-
getDoNotCheckCapabilities
public boolean getDoNotCheckCapabilities()Get whether capabilities checking is turned off.- Specified by:
getDoNotCheckCapabilitiesin interfaceCapabilitiesIgnorer- Returns:
- true if capabilities checking is turned off.
-
resetOptions
public void resetOptions()resets the options -
resetStructure
public void resetStructure()Resets the structure (header information of the instances) -
setRetrieval
public void setRetrieval(int mode) Sets the retrieval mode.- Specified by:
setRetrievalin interfaceSaver- Parameters:
mode- the retrieval mode
-
getWriteMode
public int getWriteMode()Gets the write mode.- Specified by:
getWriteModein interfaceSaver- Returns:
- the write mode
-
setInstances
Sets instances that should be stored.- Specified by:
setInstancesin interfaceSaver- Parameters:
instances- the instances
-
getInstances
Gets instances that should be stored.- Returns:
- the instances
-
setDestination
Default implementation throws an IOException.- Specified by:
setDestinationin interfaceSaver- Parameters:
file- the File- Throws:
IOException- always
-
setDestination
Default implementation throws an IOException.- Specified by:
setDestinationin interfaceSaver- Parameters:
output- the OutputStream- Throws:
IOException- always
-
getCapabilities
Returns the Capabilities of this saver. Derived savers have to override this method to enable capabilities.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Returns:
- the capabilities of this object
- See Also:
-
setStructure
Sets the strcuture of the instances for the first step of incremental saving. The instances only need to have a header.- Parameters:
headerInfo- an instances object.- Returns:
- the appropriate write mode
-
cancel
public void cancel()Cancels the incremental saving process if the write mode is CANCEL. -
writeIncremental
Method for incremental saving. Standard behaviour: no incremental saving is possible, therefore throw an IOException. An incremental saving process is stopped by calling this method with null.- Specified by:
writeIncrementalin interfaceSaver- Parameters:
i- the instance to be saved- Throws:
IOException- IOEXception if the instance acnnot be written to the specified destination
-
writeBatch
Writes to a file in batch mode To be overridden.- Specified by:
writeBatchin interfaceSaver- Throws:
IOException- exception if writting is not possible
-
getFileExtension
Default implementation throws an IOException.- Specified by:
getFileExtensionin interfaceSaver- Returns:
- a string conatining the file extension (including the '.')
- Throws:
IOException- alwaysException- exception if a Saver not implementing FileSourcedConverter is used.
-
setFile
Default implementation throws an IOException.- Specified by:
setFilein interfaceSaver- Parameters:
file- the File- Throws:
IOException- always
-
setFilePrefix
Default implementation throws an IOException.- Specified by:
setFilePrefixin interfaceSaver- Parameters:
prefix- the file prefix- Throws:
IOException- alwaysException- exception if a Saver not implementing FileSourcedConverter is used.
-
filePrefix
Default implementation throws an IOException.- Specified by:
filePrefixin interfaceSaver- Returns:
- the prefix of the file name
- Throws:
IOException- alwaysException- exception if a Saver not implementing FileSourcedConverter is used.
-
setDir
Default implementation throws an IOException.- Specified by:
setDirin interfaceSaver- Parameters:
dir- the name of the directory to save in- Throws:
IOException- always
-
setDirAndPrefix
Default implementation throws an IOException.- Specified by:
setDirAndPrefixin interfaceSaver- Parameters:
relationName-add-- Throws:
IOException- always
-
retrieveDir
Default implementation throws an IOException.- Specified by:
retrieveDirin interfaceSaver- Returns:
- the directory as a string
- Throws:
IOException- always
-