Changeset 5164 for trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java

Timestamp:

2003-08-18T14:10:31+12:00 (21 years ago)

Author:

jmt12

Message:

I can't remember what has changed, but I bet it was for the better

File:

• trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java (modified) (15 diffs)

trunk/gli/src/org/greenstone/gatherer/gui/OptionsPane.java

@@ -42 +42 @@
 import javax.swing.*;
 import javax.swing.event.*;
+import javax.swing.text.*;
 import org.greenstone.gatherer.Gatherer;
 import org.greenstone.gatherer.cdm.Argument;
@@ -49 +50 @@
 import org.greenstone.gatherer.collection.CollectionManager;
 import org.greenstone.gatherer.msm.ElementWrapper;
+import org.greenstone.gatherer.util.AppendLineOnlyFileDocument;
+import org.greenstone.gatherer.util.AppendLineOnlyFileDocumentOwner;
 import org.greenstone.gatherer.util.Utility;
 //import org.w3c.dom.*;
@@ -55 +58 @@
  * @version 2.2
  */
-final public class OptionsPane
-    extends JPanel {
+public class OptionsPane
+    extends JPanel 
+    implements AppendLineOnlyFileDocumentOwner {
+
+    static final public char SUCCESSFUL = 's';
+    static final public char UNSUCCESSFUL = 'u';
+    static final public char CANCELLED = 'c';
+    static final public char UNKNOWN = 'x';
+
+    /** All process messages are written to this log text area. */
+    public JTextArea log_textarea = null;
+
     /** The <strong>BuildOptions</strong> data object contains all the option settings we wish to persist between Gatherer sessions (and thus is stored in <strong>Collection</strong>). */
     private BuildOptions build_options = null;
+
+    private FileEntry file_entry = null;
     /** the log pane - we only create it once now, not each time */
     private JPanel log_pane = null;
     /** the list of previous log messages */
     private JList log_list = null;
-    /** whether that currently showing log is changed or not */
-    private boolean is_log_changed = false;
-    /** the list entry that is currently displayed */
-    private FileEntry displayed_log = null;
-    /** a listener for changes in the log text */
-    private LogChangeListener log_change_listener = null;
-    /** All process messages are written to this log text area. */
-    private JTextArea log_display = null;
-
-    static final public char SUCCESSFUL = 's';
-    static final public char UNSUCCESSFUL = 'u';
-    static final public char CANCELLED = 'c';
+    private Vector writing_documents;
 
     static private int BUILD = 0;
@@ -88 +92 @@
 
      /** The default constructor creates the few session length options, but either retrieves the rest from the current collection, or creates a default set of options. */
-    public OptionsPane(JTextArea message_log, BuildOptions build_options) {
-    this.log_display = new JTextArea(message_log.getDocument());
+    public OptionsPane(BuildOptions build_options) {
     this.build_options = build_options;
-    this.log_change_listener = new LogChangeListener();
-    //this.target_pane = target_pane;
-    }
-
-    /** creates a new log from the text in log. The new file is named
-     * build_log.<current time>.txt. A new FileEntry is added to teh log list
-     * and made selected. A fresh listener is added to teh document */
-    public void addNewLog(char success) {
-    ///ystem.out.println("add new log");
-
-    // create the file name
-    long time = System.currentTimeMillis();
-    StringBuffer name = new StringBuffer();
-    name.append("build_log.");
-    name.append(time);
-    name.append(success);
-    name.append(".txt");
-    File f = new File(Gatherer.c_man.getCollectionLog()+name.toString());
-    // just in case there is no log directory
-    File parent_file = f.getParentFile();
-    parent_file.mkdirs();
-
-    // save the log text to the file
-    saveLogFile(f);
-    is_log_changed=false;
-    log_display.getDocument().addDocumentListener(log_change_listener);
-
-    // create the file entry and add it to the list at pos 0 - it will always be the newest one created
-    FileEntry fe = new FileEntry(f);
-    ((DefaultListModel)log_list.getModel()).add(0, fe);
-    log_list.setSelectedIndex(0);
-    displayed_log = fe;
-
+    this.writing_documents = new Vector();
+
+    // Have to do this here, not in display, as the message log view may not have been displayed yet.
+    log_textarea = new JTextArea();
+    log_textarea.setEditable(false);
     }
 
@@ -134 +109 @@
     pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
     int build_argument_count = build_options.getBuildArgumentCount();
-    pane.setLayout(new GridLayout(build_argument_count, 1, 0, 0));
-    int total_height = PANE_SIZE.height;
+    pane.setPreferredSize(new Dimension(ROW_SIZE.width, ROW_SIZE.height * build_argument_count));
     for(int i = 0; i < build_argument_count; i++) {
         // Retrieve the argument so we know how to format the control.
@@ -143 +117 @@
         String value = build_options.getBuildValue(argument.getName());
         ArgumentControl argument_control = new ArgumentControl(BUILD, argument, enabled, value);
-        total_height = total_height - argument_control.getPreferredSize().height;
         pane.add(argument_control);
-    }
-    if(total_height > 0) {
-        JPanel filler = new JPanel();
-        filler.setPreferredSize(new Dimension(100, total_height));
-        filler.setSize(filler.getPreferredSize());
-        pane.add(filler);
     }
     return pane;
@@ -162 +129 @@
     pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
     int import_argument_count = build_options.getImportArgumentCount();
-    pane.setLayout(new GridLayout(import_argument_count, 1, 0, 0));
-    int total_height = PANE_SIZE.height;
+    pane.setPreferredSize(new Dimension(ROW_SIZE.width, ROW_SIZE.height * import_argument_count));
     for(int i = 0; i < import_argument_count; i++) {
         // Retrieve the argument so we know how to format the control.
@@ -171 +137 @@
         String value = build_options.getImportValue(argument.getName());
         ArgumentControl argument_control = new ArgumentControl(IMPORT, argument, enabled, value);
-        total_height = total_height - argument_control.getPreferredSize().height;
         pane.add(argument_control);
-    }
-    if(total_height > 0) {
-        JPanel filler = new JPanel();
-        filler.setPreferredSize(new Dimension(100, total_height));
-        filler.setSize(filler.getPreferredSize());
-        pane.add(filler);
     }
     return pane;
@@ -195 +154 @@
         File children[] = log_directory.listFiles();
         for(int i = 0; children != null && i < children.length; i++) {
-        if(children[i].getName().startsWith("build_log")&&children[i].getName().endsWith(".txt") ) {
-            FileEntry entry = new FileEntry(children[i]);
+        if(children[i].getName().startsWith("build_log") && children[i].getName().endsWith(".txt") ) {
+            FileEntry entry = new FileEntry(children[i].getName(), children[i].getAbsolutePath());
             // We are about to insert it. But where.
             boolean found = false;
-            for(int j = 0; j < contents.size(); j++) {
+            for(int j = 0; !found && j < contents.size(); j++) {
             FileEntry sibling = (FileEntry) contents.getElementAt(j);
             int order = entry.compareTo(sibling);
@@ -205 +164 @@
                 contents.insertElementAt(entry, j);
                 found = true;
-                break;
             }
             }
@@ -217 +175 @@
         log_list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
         log_list.setLayoutOrientation(JList.VERTICAL);
+        log_list.setPreferredSize(new Dimension(600, 100));
         log_list.setVisibleRowCount(3);
         log_list.addListSelectionListener(new LogListListener());
 
-        JScrollPane list_scroller = new JScrollPane(log_list);
-
-        // If log is not empty and we have something in displayed_log - make that element selected
-        if (log_display.getText().length()>0 && displayed_log != null) {
-        int index = contents.indexOf(displayed_log);
-        if (index != -1) {
-            log_list.setSelectedIndex(index);
-        }
-
-        }
-
-        log_pane.add(new JScrollPane(log_display), BorderLayout.CENTER);
         JLabel log_history_label = new JLabel(get("LogHistory"));
         JPanel log_history_pane = new JPanel();
-
+        log_history_pane.setPreferredSize(new Dimension(600, 100));
         log_history_pane.setLayout(new BorderLayout());
         log_history_pane.add(log_history_label, BorderLayout.NORTH);
-        log_history_pane.add(list_scroller, BorderLayout.SOUTH);
+        log_history_pane.add(new JScrollPane(log_list), BorderLayout.CENTER);
         
+        log_pane.add(new JScrollPane(log_textarea), BorderLayout.CENTER);
         log_pane.add(log_history_pane, BorderLayout.SOUTH);
     }
     return log_pane;
+    }
+
+    public AppendLineOnlyFileDocument createNewLogDocument() {
+    long time = System.currentTimeMillis();
+    StringBuffer name = new StringBuffer();
+    name.append("build_log.");
+    name.append(time);
+    name.append(".txt");
+    // just in case there is no log directory
+    File file = new File(Gatherer.c_man.getCollectionLog() + name.toString());
+    File parent_file = file.getParentFile();
+    parent_file.mkdirs();
+    parent_file = null;
+    // create the file entry and add it to the list at pos 0 - it will always be the newest one created
+    file_entry = new FileEntry(name.toString(), file.getAbsolutePath());
+    ((DefaultListModel)log_list.getModel()).add(0, file_entry);
+    log_list.setSelectedIndex(0);
+    // Finally retrieve and return the document associated with this file entry
+    return file_entry.getDocument();
     }
 
@@ -265 +232 @@
     }
     /** Attempts to discover the latest document count.
-      * @return An <strong>int</strong> detailing the number of documents in this collection.
-     */
+     * @return An <strong>int</strong> detailing the number of documents in this collection.
+     */
     public int getDocumentCount() {
     if(Gatherer.c_man.ready()) {
@@ -277 +244 @@
     }
 
-    /** Loads a new log into the log text - saves the currently showing one,
-     * and loads the new one, adding a fresh listener to the document
-     * Note, we need to remove any listener before making the changes, then
-     * add a listener back in
-     */
-    public void loadSelectedLog(FileEntry fe) {
-    ///ystem.out.println("load selected log");
-    if(displayed_log != null) {
-        if (is_log_changed) {
-        saveLogFile(displayed_log.getFile());
-        } else {
-        log_display.getDocument().removeDocumentListener(log_change_listener);
-        }
-    }
-
-    displayed_log = fe;
-    if (fe != null) {
-        log_display.setText(fe.getFileText());
-    } else {
-        log_display.setText("");
-    }
-    is_log_changed=false;
-    log_display.getDocument().addDocumentListener(log_change_listener);
-
-    }
-
-    /** Neutralizes the log list - saves any unsaved changes to the current log
-     * clears the log text, unselects the log list, and adds a fresh listener
-     * to the log's document
-     * Note, we need to remove any listener before making the changes, then
-     * add a listener back in */
-    public void resetLogList() {
-    ///ystem.out.println("reset log");
-    if (is_log_changed) {
-        saveLogFile(displayed_log.getFile());
-    } else {
-        log_display.getDocument().removeDocumentListener(log_change_listener);
-    }
-    log_display.setText("");
-    displayed_log = null;
-    if (log_list != null) {
-        log_list.clearSelection();
-    }
-    is_log_changed=false;
-    log_display.getDocument().addDocumentListener(log_change_listener);
-
-    }
-
-    /** saves the current text in log to the File specified */
-    public void saveLogFile(File file) {
-
-    try {
-        BufferedWriter out = new BufferedWriter(new FileWriter(file)); // uses the default encoding
-        String log_text = log_display.getText();
-        // set teh return delims to true, then swap them for newLine() (platform dependent) - having return delims set to false seemed to not get empty strings so that empty lines were not preserved.
-        StringTokenizer t = new StringTokenizer(log_text, "\n", true);
-        while (t.hasMoreTokens()) {
-        String token = t.nextToken();
-        if (token.equals("\n")) {
-            out.newLine();
-        } else {
-            out.write(token, 0, token.length());
-        }
-
-        }
-        out.close();
-
-    } catch(Exception e) {
-        System.out.println("Error in saving log file: "+file.toString());
-        e.printStackTrace();
-    }
-
-
-    }
-
+    /** Called by our magic log documents after they have finished writing themselves to file, whereapon it is no longer necessary to hold a reference to them. */
+    public void remove(AppendLineOnlyFileDocument document) {
+    writing_documents.remove(document);
+    }
+
+    public void resetFileEntry() {
+    if(file_entry != null) {
+        file_entry.reset();
+    }
+    }
 
     /** Given a panel containing ArgumentControls, update the values associated with them. */
@@ -591 +493 @@
     }
 
-    /** holds a File which has a particular naming convention
-     * build_log.date.txt
-     * also keeps a Date corresponding to the date in its name*/
+    /** Holds a File which has a particular naming convention build_log.date.txt also keeps a Date corresponding to the date in its name*/
     private class FileEntry {
 
-    private Date date=null;
-    private File file=null;
-    private String display=null;
-    public FileEntry(File f) {
-        this.file=f;
-        this.date = getDateFromFileName();
-        this.display = createDisplayText();
-
+    private Date date;
+    private long last_modified;
+    private String display;
+    private String filename;
+    private String filepath;
+
+    public FileEntry(String filename, String filepath) {
+        this.date = null;
+        this.display = null;
+        this.filename = filename;
+        this.filepath = filepath;
+        this.last_modified = 0L;
     }
 
     /** returns 0 if the dates are the same, -ve number if the current FileEntry is earlier than the fe FileEntry ...*/
-    public int compareTo(FileEntry fe) {
-        Date d = fe.getDate();
-        return date.compareTo(d);
+    public int compareTo(FileEntry file_entry) {
+        Date our_date = getDate();
+        Date other_date = file_entry.getDate();
+        return our_date.compareTo(other_date);
     }
 
     public Date getDate() {
-        return this.date;
-    }
-    public File getFile() {
-        return this.file;
-    }
-    /** returns the contents of the file */
-    public String getFileText() {
-        if (!this.file.exists()) {
-        return "";
-        }
-        StringBuffer contents = new StringBuffer();
-        try {
-        BufferedReader in = new BufferedReader(new FileReader(this.file));
-        String line;
-
-        while ((line = in.readLine()) != null) {
-            contents.append(line);
-            contents.append("\n");
-        }
-        } catch (FileNotFoundException fnfe) {
-        Gatherer.println("Error: log file not found: "+ this.file.toString());
-        return "";
-        } catch (IOException ioe) {
-        Gatherer.println("Error: exception occurred when trying to read in file "+this.file.toString()+", "+ioe.getMessage());
-
-        }
-
-        return contents.toString();
-    }
+        if(date == null) {
+        // Need to exclude first '.'
+        int first_index = filename.indexOf(".") + 1;
+        // Need to exclude the last '.'
+        int last_index = filename.lastIndexOf(".");
+        if(first_index > 0 && last_index > 0 && first_index < last_index) {
+            String date_string = filename.substring(first_index, last_index);
+            date = new Date(Long.parseLong(date_string));
+        }
+        else {
+            date = new Date(); // Current date
+        }
+        }
+        return date;
+    }
+
+    public AppendLineOnlyFileDocument getDocument() {
+        return new AppendLineOnlyFileDocument(filepath);
+    }
+
+    public void reset() {
+        display = null;
+    }
+
     /** we only want the date out of the file name, not the whole path */
     public String toString() {
-        return this.display;
-    }
-    /** creates the display text for the list */
-    private String createDisplayText() {
-        StringBuffer d = new StringBuffer();
-        d.append(date.toString());
-        //char success= this.file.getName().charAt(23);
-        String filename = this.file.getName();
-        int index = filename.lastIndexOf(".") - 1;
-        if(index >= 0) {
-            char success = filename.charAt(index);
-            switch (success) {
-            case OptionsPane.SUCCESSFUL:
-            d.append(get("Successful"));
-            break;
-            case OptionsPane.UNSUCCESSFUL:
-            d.append(get("Unsuccessful"));
-            break;
-            case OptionsPane.CANCELLED:
-            d.append(get("Cancelled"));
-            break;
-            }
-        }
-        return d.toString();
-    }
-    /** extracts the date from the file name, which is of the form 'build_log.'<long>[scu]'.txt' */
-    private Date getDateFromFileName() {
-        String name = this.file.getName();
-        // Need to exclude first '.'
-        int first_index = name.indexOf(".") + 1;
-        // Need to exclude state letter before last '.'
-        int last_index = name.lastIndexOf(".") - 1;
-        if(first_index > 0 && last_index > 0 && first_index < last_index) {
-        String date_string = name.substring(first_index, last_index);
-        return new Date(Long.parseLong(date_string));
-        }
-        else {
-        return new Date(); // Current date
-        }
-    }
-
-
-    }
-
-    /** A DocumentListener that listens for changes in the log_display document
-     * if a change is registered, the flag is_log_changed is set to true,
-     * and the listener removes itself from log_display
-     * Because we only want to register user's changes, the listener must be removed before the system makes any changes, and then put back. For example, each time we switchlogs to display, a remove event and an insert event are sent. We dont want to register these as changes to the document, so the listener must be removed before the switch, and added back afterwards */
-    private class LogChangeListener implements DocumentListener {
-
-    public void changedUpdate(DocumentEvent e) {
-        ///ystem.out.println("changed update");
-        registerChange();
-    }
-    public void insertUpdate(DocumentEvent e) {
-        ///ystem.out.println("insert update");
-        registerChange();
-    }
-    public void removeUpdate(DocumentEvent e) {
-        ///ystem.out.println("remove update");
-        registerChange();
-    }
-
-    private void registerChange() {
-        ///ystem.err.println("a change in the doc occurred, removing the listener");
-        is_log_changed = true;
-        log_display.getDocument().removeDocumentListener(this);
-    }
-    }
-
-    /** a ListSelectionListener that triggers the load of a newly selected
-    log */
+        File file = new File(filename);
+        if(display == null) {
+        last_modified = file.lastModified();
+        StringBuffer d = new StringBuffer();
+        Date date = getDate();
+        d.append(date.toString());
+        char success = UNKNOWN;
+        try {
+            FileInputStream in = new FileInputStream(new File(filepath));
+            success = (char) in.read();
+            in.close();
+            in = null;
+        }
+        catch(Exception error) {
+            error.printStackTrace();
+        }
+        switch (success) {
+        case SUCCESSFUL:
+            d.append(get("Successful"));
+            break;
+        case UNSUCCESSFUL:
+            d.append(get("Unsuccessful"));
+            break;
+        case CANCELLED:
+            d.append(get("Cancelled"));
+            break;
+        default:
+            d.append(get("Unknown"));
+        }
+        display = d.toString();
+        }
+        return display;
+    }
+    }
+
+    /** a ListSelectionListener that triggers the load of a newly selected log */
     private class LogListListener implements ListSelectionListener {
 
@@ -721 +585 @@
         if (!e.getValueIsAdjusting()) { // we get two events for one change in list selection - use the false one ( the second one)
         JList source  = (JList)e.getSource();
-        FileEntry fe = (FileEntry) source.getSelectedValue();
-        loadSelectedLog(fe);
+        file_entry = (FileEntry) source.getSelectedValue();
+        // First we determine if the old log has been completely written to file
+        Document document = log_textarea.getDocument();
+        if(document instanceof AppendLineOnlyFileDocument) {
+            AppendLineOnlyFileDocument append_line_only_file_document = (AppendLineOnlyFileDocument) document;
+            if(append_line_only_file_document.isStillWriting()) {
+                writing_documents.add(append_line_only_file_document); // We have to maintain a reference until they are all done.
+                append_line_only_file_document.setOwner(OptionsPane.this);
+                append_line_only_file_document.setExit();
+            }
+        }
+        // Load the new log
+        log_textarea.setDocument(file_entry.getDocument());
         }
     }