edu.duke.cs.banjo.utility
Class FileUtil

java.lang.Object
  extended byedu.duke.cs.banjo.utility.FileUtil

public class FileUtil
extends java.lang.Object

Handles all file input and output for the application.

Details:

Change History:
Created on Apr 16, 2004

2/23/2006 (v2.0) hjs Use standard Banjo validation for files and directories.

hjs (v2.1) Updated for multi-threaded execution

Author:
Jurgen Sladeczek (hjs)
For the latest info, please visit www.cs.duke.edu.

Field Summary
private  java.lang.String[] fileName
           
private  boolean[] fileReady
           
private  java.io.FileWriter[] fileWriter
           
private  java.io.PrintWriter[] printWriter
           
private  Settings processData
           
private  java.util.Properties settings
           
private  java.io.OutputStreamWriter[] streamWriter
           
private  java.lang.String[] traceFileName
           
private  boolean traceToConsole
           
 
Constructor Summary
FileUtil()
           
FileUtil(Settings _processData)
           
 
Method Summary
protected  java.lang.String getTraceFileName(int _traceFileID)
           
 ObservationsI loadObservations()
           
 java.util.Properties loadSettings(java.lang.String _directoryName, java.lang.String _inputFileName)
           
 void prepareResultsFile()
           
 void prepareXMLResultsFile()
           
 void recordError(java.lang.String _strErrorMessage)
           
protected  void setTraceFileName(int _traceFileID, java.lang.String _traceFileName)
           
 void setupFile(java.io.FileWriter _fileWriter, java.io.OutputStreamWriter _outputStreamWriter, java.io.PrintWriter _printWriter, java.lang.String _fileName)
           
 void writeStringToFile(java.lang.String _fileName, java.lang.String _dataToWrite, boolean _traceToConsole)
          Wrapper for writing a string to a file.
 void writeToFile(java.util.Collection _outputFileFlags, java.lang.StringBuffer _dataToWrite)
          Validates the settings values required for the file access.
 void writeTraceToFile(java.lang.String _dataToWrite, boolean _traceToConsole, int _traceFileID)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fileWriter

private java.io.FileWriter[] fileWriter

streamWriter

private java.io.OutputStreamWriter[] streamWriter

printWriter

private java.io.PrintWriter[] printWriter

fileName

private java.lang.String[] fileName

fileReady

private boolean[] fileReady

settings

private java.util.Properties settings

processData

private Settings processData

traceToConsole

private boolean traceToConsole

traceFileName

private java.lang.String[] traceFileName
Constructor Detail

FileUtil

public FileUtil()
         throws java.lang.Exception

FileUtil

public FileUtil(Settings _processData)
         throws java.lang.Exception
Method Detail

prepareResultsFile

public void prepareResultsFile()
                        throws java.lang.Exception
Throws:
java.lang.Exception

prepareXMLResultsFile

public void prepareXMLResultsFile()
                           throws java.lang.Exception
Throws:
java.lang.Exception

writeToFile

public void writeToFile(java.util.Collection _outputFileFlags,
                        java.lang.StringBuffer _dataToWrite)
                 throws java.lang.Exception
Validates the settings values required for the file access.

Returns:
Returns the boolean flag that indicates whether a crucial setting could not be validated.
Throws:
java.lang.Exception

setupFile

public void setupFile(java.io.FileWriter _fileWriter,
                      java.io.OutputStreamWriter _outputStreamWriter,
                      java.io.PrintWriter _printWriter,
                      java.lang.String _fileName)
               throws java.lang.Exception
Throws:
java.lang.Exception

recordError

public void recordError(java.lang.String _strErrorMessage)
                 throws java.lang.Exception
Throws:
java.lang.Exception

loadSettings

public java.util.Properties loadSettings(java.lang.String _directoryName,
                                         java.lang.String _inputFileName)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

loadObservations

public ObservationsI loadObservations()
                               throws java.lang.Exception
Throws:
java.lang.Exception

setTraceFileName

protected void setTraceFileName(int _traceFileID,
                                java.lang.String _traceFileName)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getTraceFileName

protected java.lang.String getTraceFileName(int _traceFileID)
                                     throws java.lang.Exception
Throws:
java.lang.Exception

writeTraceToFile

public void writeTraceToFile(java.lang.String _dataToWrite,
                             boolean _traceToConsole,
                             int _traceFileID)
                      throws java.lang.Exception
Throws:
java.lang.Exception

writeStringToFile

public void writeStringToFile(java.lang.String _fileName,
                              java.lang.String _dataToWrite,
                              boolean _traceToConsole)
                       throws java.lang.Exception
Wrapper for writing a string to a file.

Throws:
java.lang.Exception