public interface Saver extends java.io.Serializable, RevisionHandler
Modifier and Type | Field and Description |
---|---|
static int |
BATCH |
static int |
INCREMENTAL |
static int |
NONE
The retrieval modes
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
filePrefix()
Gets the file prefix
This method is used in the KnowledgeFlow GUI.
|
java.lang.String |
getFileExtension()
Gets the file extension
|
int |
getWriteMode()
Gets the write mode
|
java.lang.String |
retrieveDir()
Gets the driectory of the output file
This method is used in the KnowledgeFlow GUI.
|
void |
setDestination(java.io.File file)
Resets the Saver object and sets the destination to be
the supplied File object.
|
void |
setDestination(java.io.OutputStream output)
Resets the Saver object and sets the destination to be
the supplied InputStream.
|
void |
setDir(java.lang.String dir)
Sets the directory of the output file.
|
void |
setDirAndPrefix(java.lang.String relationName,
java.lang.String add)
Sets the file prefix and the directory.
|
void |
setFile(java.io.File file)
Sets the output file
|
void |
setFilePrefix(java.lang.String prefix)
Sets the file prefix.
|
void |
setInstances(Instances instances)
Sets the instances to be saved
|
void |
setRetrieval(int mode)
Sets the retrieval mode
|
void |
writeBatch()
Writes to a destination in batch mode
|
void |
writeIncremental(Instance inst)
Writes to a destination in incremental mode.
|
getRevision
static final int NONE
static final int BATCH
static final int INCREMENTAL
void setDestination(java.io.File file) throws java.io.IOException
file
- the Filejava.io.IOException
- if an error occurs
support loading from a File.
public_normal_behavior requires: file != null && (* file exists *); modifiable: model_sourceSupplied, model_structureDetermined; ensures: model_sourceSupplied == true && model_structureDetermined == false; also public_exceptional_behavior requires: file == null || (* file does not exist *); signals: (IOException);
void setDestination(java.io.OutputStream output) throws java.io.IOException
output
- the output streamjava.io.IOException
- if this Loader doesn't
support loading from a File.void setRetrieval(int mode)
mode
- an integer representing a retrieval modejava.lang.String getFileExtension() throws java.lang.Exception
java.lang.Exception
- exception if a Saver not implementing FileSourcedConverter is used.void setFile(java.io.File file) throws java.io.IOException
file
- the output filejava.io.IOException
- exception if new output file cannot be setvoid setFilePrefix(java.lang.String prefix) throws java.lang.Exception
prefix
- the prefix of the file namejava.lang.Exception
- exception if a Saver not implementing FileSourcedConverter is used.java.lang.String filePrefix() throws java.lang.Exception
java.lang.Exception
- exception if a Saver not implementing FileSourcedConverter is used.void setDir(java.lang.String dir) throws java.io.IOException
dir
- a string containing the path and name of the directoryjava.io.IOException
- exception if a Saver not implementing FileSourcedConverter is used.void setDirAndPrefix(java.lang.String relationName, java.lang.String add) throws java.io.IOException
relationName
- the name of the realtion to be savedadd
- additional String for the file namejava.io.IOException
- exception if a Saver not implementing FileSourcedConverter is used.java.lang.String retrieveDir() throws java.io.IOException
java.io.IOException
- exception if a Saver not implementing FileSourcedConverter is used.void setInstances(Instances instances)
instances
- the instancesvoid writeBatch() throws java.io.IOException
java.io.IOException
- throws exection if writting in batch mode is not possiblevoid writeIncremental(Instance inst) throws java.io.IOException
inst
- the instance to write, if null the output file is closedjava.io.IOException
- throws exception if incremental writting is not possibleint getWriteMode()