*
* -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.
*
*
* @author Richard Kirkby (rkirkby@cs.waikato.ac.nz)
* @author Stefan Mutter (mutter@cs.waikato.ac.nz)
* @version $Revision: 1.1.2.1 $
*/
public abstract class AbstractFileSaver extends AbstractSaver implements OptionHandler, FileSourcedConverter{
/** The destination file. */
private File m_outputFile;
/** The writer. */
private transient BufferedWriter m_writer;
/** The file extension of the destination file. */
private String FILE_EXTENSION;
/** The prefix for the filename (chosen in the GUI). */
private String m_prefix;
/** The directory of the file (chosen in the GUI).*/
private String m_dir;
/** Counter. In incremental mode after reading 100 instances they will be written to a file.*/
protected int m_incrementalCounter;
/**
* resets the options
*
*/
public void resetOptions(){
super.resetOptions();
m_outputFile = null;
m_writer = null;
m_prefix = "";
m_dir = "";
m_incrementalCounter = 0;
}
/**
* Gets the writer
*
* @return the BufferedWriter
*/
public BufferedWriter getWriter(){
return m_writer;
}
/** Sets the writer to null. */
public void resetWriter(){
m_writer = null;
}
/**
* Gets ihe file extension.
*
* @return the file extension as a string.
*/
public String getFileExtension(){
return FILE_EXTENSION;
}
/**
* Sets ihe file extension.
*
* @param ext the file extension as a string startin with '.'.
*/
protected void setFileExtension(String ext){
FILE_EXTENSION = ext;
}
/**
* Gets the destination file.
*
* @return the destination file.
*/
public File retrieveFile(){
return m_outputFile;
}
/** Sets the destination file.
* @param outputFile the destination file.
* @throws IOException throws an IOException if file cannot be set
*/
public void setFile(File outputFile) throws IOException {
m_outputFile = outputFile;
}
/** Sets the file name prefix
* @param prefix the file name prefix
*/
public void setFilePrefix(String prefix){
m_prefix = prefix;
}
/** Gets the file name prefix
* @return the prefix of the filename
*/
public String filePrefix(){
return m_prefix;
}
/** Sets the directory where the instances should be stored
* @param dir a string containing the directory path and name
*/
public void setDir(String dir){
m_dir = dir;
}
/** Gets the directory
* @return a string with the file name
*/
public String retrieveDir(){
return m_dir;
}
/**
* Returns an enumeration describing the available options.
*
* @return an enumeration of all the available options.
*/
public Enumeration listOptions() {
FastVector newVector = new FastVector(2);
newVector.addElement(new Option("The input file", "i", 1,
"-i
*
* -i input arff file
*
* -o the output file
*
*
* @param options the list of options as an array of strings
* @exception Exception if an option is not supported
*/
public void setOptions(String[] options) throws Exception {
String outputString = Utils.getOption('o', options);
String inputString = Utils.getOption('i', options);
ArffLoader loader = new ArffLoader();
resetOptions();
if(inputString.length() != 0){
try{
File input = new File(inputString);
loader.setFile(input);
setInstances(loader.getDataSet());
} catch(Exception ex){
throw new IOException("No data set loaded. Data set has to be in ARFF format.");
}
}
else
throw new IOException("No data set to save.");
if (outputString.length() != 0){
//add appropriate file extension
if(!outputString.endsWith(FILE_EXTENSION)){
if(outputString.lastIndexOf('.') != -1)
outputString = (outputString.substring(0,outputString.lastIndexOf('.'))) + FILE_EXTENSION;
else
outputString = outputString + FILE_EXTENSION;
}
try{
File output = new File(outputString);
setFile(output);
} catch(Exception ex){
throw new IOException("Cannot create output file. Standard out is used.");
} finally{
setDestination(m_outputFile);
}
}
}
/**
* Gets the current settings of the Saver object.
*
* @return an array of strings suitable for passing to setOptions
*/
public String [] getOptions() {
String [] options = new String [10];
int current = 0;
if(m_outputFile != null){
options[current++] = "-o"; options[current++] = "" + m_outputFile;
}
else{
options[current++] = "-o"; options[current++] = "";
}
if(getInstances() != null){
options[current++] = "-i"; options[current++] = "" + getInstances().relationName();
}
else{
options[current++] = "-i"; options[current++] = "";
}
while (current < options.length) {
options[current++] = "";
}
return options;
}
/** Cancels the incremental saving process. */
public void cancel(){
if(getWriteMode() == CANCEL){
if(m_outputFile != null && m_outputFile.exists()){
if(m_outputFile.delete())
System.out.println("File deleted.");
}
resetOptions();
}
}
/**
* Sets the destination file (and directories if necessary).
*
* @param file the File
* @exception IOException always
*/
public void setDestination(File file) throws IOException {
boolean success = false;
String out = file.getAbsolutePath();
if(m_outputFile != null){
try{
if(file.exists()){
if(file.delete())
System.out.println("File exists and will be overridden.");
else
throw new IOException("File already exists.");
}
if(out.lastIndexOf(File.separatorChar) == -1){
success = file.createNewFile();
}
else{
String outPath = out.substring(0,out.lastIndexOf(File.separatorChar));
File dir = new File(outPath);
if(dir.exists())
success = file.createNewFile();
else{
dir.mkdirs();
success = file.createNewFile();
}
}
if(success){
m_outputFile = file;
setDestination(new FileOutputStream(m_outputFile));
}
} catch(Exception ex){
throw new IOException("Cannot create a new output file. Standard out is used.");
} finally{
if(!success){
System.err.println("Cannot create a new output file. Standard out is used.");
m_outputFile = null; //use standard out
}
}
}
}
/** Sets the destination output stream.
* @param output the output stream.
* @throws IOException throws an IOException if destination cannot be set
*/
public void setDestination(OutputStream output) throws IOException {
m_writer = new BufferedWriter(new OutputStreamWriter(output));
}
/** Sets the directory and the file prefix.
* This method is used in the KnowledgeFlow GUI
* @param relationName the name of the relation to save
* @param add additional string which should be part of the filename
*/
public void setDirAndPrefix(String relationName, String add){
try{
if(m_dir.equals(""))
m_dir = System.getProperty("user.dir");
if(m_prefix.equals(""))
setFile(new File(m_dir + File.separator + relationName+ add + FILE_EXTENSION));
else
setFile(new File(m_dir + File.separator + m_prefix + "_" + relationName+ add + FILE_EXTENSION));
setDestination(m_outputFile);
}catch(Exception ex){
System.err.println("File prefix and/or directory could not have been set.");
ex.printStackTrace();
}
}
/**
* to be pverridden
*
* @return the file type description.
*/
public abstract String getFileDescription();
}
* The input filw in arff format.
* The output file. The prefix of the output file is sufficient. If no output file is given, Saver tries to use standard out.