Changeset 1627

Timestamp:

2000-10-30T15:10:28+13:00 (24 years ago)

Author:

paynter

Message:

The applet is now operational. Phrases work, documents work, getting new
phrases and documents work, backdrops work.

Location:

trunk/gsdl/src/phind/client

Files:

• Phind.java (modified) (7 diffs)
• PhindTitle.java (modified) (2 diffs)
• ResultBox.java (modified) (8 diffs)
• ResultCanvas.java (modified) (3 diffs)
• ResultDisplay.java (modified) (3 diffs)

trunk/gsdl/src/phind/client/Phind.java

@@ -55 +55 @@
    words on the screen, and handles user input from the mouse.
 6. ResultItem represents a single result object (a phrase or document).
-
-7. PhindTitle is for drawing backdrops in empty Displays. (?)
+7. PhindTitle is for drawing backdrops in ResultDisplays.
 
 **********************************************************************/
@@ -104 +103 @@
 
     // Do we want a background image in the applet?
+    String backdrop_address;
     public boolean showImage;
     public Image backgroundImage;
@@ -109 +109 @@
     // Holders for the downloaded data
     Panel resultPanel;
-    PhindTitle title;
     ResultDisplay firstDisplay, lastDisplay;
 
@@ -198 +197 @@
     System.out.println("Phind library: " + library_address);
 
+    // Should we display a background image?
+    showImage = false;
+    try { 
+        backdrop_address = new String(getParameter("backdrop"));
+        URL backdrop_url = new URL(backdrop_address);
+        backgroundImage = getImage(backdrop_url);
+        showImage = true;
+        System.out.println("Phind backdrop: " + backdrop_address);
+    } catch (Exception e) { 
+        System.out.println("Phind backdrop not set");
+    }
+
     // Is there a search URL for this collection?
     try {
@@ -238 +249 @@
     System.out.println("Phind phrase block size: " + phraseBlockSize);
 
-    // Should we display a background image?
-    showImage = false;
-    try { 
-        if (getParameter("background").toLowerCase().equals("on")) {
-        showImage = true;
-        System.out.println("Phind background: on");
-        }
-    } catch (Exception e) { 
-        System.out.println("Phind background: off");
-    }
-
-
     // How large should the font be?
     try { 
@@ -271 +270 @@
     // The phind applet layout manager
     setLayout(new BorderLayout());
-
-    // the Phind title window
-    if (showImage) backgroundImage = getImage(getCodeBase(), "sequitur.jpg");
-    title = new PhindTitle(this, true);
 
     // initialise the user interface
@@ -495 +490 @@
     throws IOException {
 
-    // Set up connections (streams)
-    //connection = new Socket(server, Integer.parseInt(port));
-    //OutputStream out = connection.getOutputStream();
-    //InputStream in = connection.getInputStream();
-
     // Build the query
     String query = phindcgi_address + "?x=1&c=" + collection;
 
     if (keyKnown) {
-        query = query + "&n=" + word;
+      query = query + "&n=" + word;
     } else {
-        query = query + "&p=" + word;
-    }
-
-    // Specify the number of results to return and the first and last results.
+      query = query + "&p=" + word;
+    }
+
+    
+    // Specify the set of results to return 
+    int first_e = 0;
+    int last_e = 0;
+    int first_d = 0;
+    int last_d = 0;
+
+    // the initial query
     if (queryMode <= 2) {
-        query = query + "&f=0&d=" + phraseBlockSize + "&g=0&e=" + phraseBlockSize;
-    } else if (queryMode == 3) {
-        // Add phrases to an existing result set.
-        query = query + "&f=0&d=" + phraseBlockSize + "&g=0&e=" + phraseBlockSize;
-        // query = (word + " " + queryMode + " " + phraseBlockSize + " " + area.nextPhraseBlock);
-        area.nextPhraseBlock++;
-    } else if (queryMode == 4) {
-        // Add documents to existing result set.
-        query = query + "&f=0&d=" + phraseBlockSize + "&g=0&e=" + phraseBlockSize;
-        // query = (word + " " + queryMode + " " + phraseBlockSize + " " + area.nextDocumentBlock);
-        area.nextDocumentBlock++;
-    }
-
+      last_e = phraseBlockSize;
+      last_d = phraseBlockSize;
+    }
+ 
+    // add phrases to an existing result set
+    else if (queryMode == 3) {
+      first_e = area.nextPhraseBlock * phraseBlockSize;
+      area.nextPhraseBlock++;
+      last_e = area.nextPhraseBlock * phraseBlockSize;
+    } 
+    
+    // add documents to existing result set
+    else if (queryMode == 4) {
+      first_d = area.nextDocumentBlock * phraseBlockSize;
+      area.nextDocumentBlock++;
+      last_d = area.nextDocumentBlock * phraseBlockSize;
+    }
+
+    query = query + "&f=" + first_d + "&d=" + last_d 
+                  + "&g=" + first_e + "&e=" + last_e;
 
     // Send the query to the phindcgi program 

trunk/gsdl/src/phind/client/PhindTitle.java

@@ +1 @@
+/**********************************************************************
+ *
+ * PhindTitle.java -- backdrops to empty ResultDisplay panels.
+ *
+ * Copyright 1997-2000 Gordon W. Paynter
+ * Copyright 2000 The New Zealand Digital Library Project
+ *
+ * A component of the Greenstone digital library software
+ * from the New Zealand Digital Library Project at the
+ * University of Waikato, New Zealand.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ *********************************************************************/
+
+
+/*********************************************************************
+
+PhindTitle is for drawing backdrops in empty ResultDisplay panels.
+
+**********************************************************************/
+
 import java.applet.Applet;
 import java.awt.Canvas;
 import java.awt.Color;
 import java.awt.Dimension;
-import java.awt.Font;
 import java.awt.Graphics;
 import java.awt.Image;
@@ -9 +42 @@
 public class PhindTitle extends Canvas {
 
-  Phind phind;
-  static Image backgroundImage;
-  boolean displayInfo;
-
-  PhindTitle(Phind p, boolean disp) {
-    backgroundImage = p.backgroundImage;
-    displayInfo = disp;
-    phind = p;
-  }
-
-  public void update(Graphics g) {
-    paint(g);
-  }
-
-  public void paint(Graphics g) {
-    Dimension canvasSize = size();
-
-    // set the screen background
-    if (phind.showImage)
-      g.drawImage(backgroundImage, 0, 0, canvasSize.width, canvasSize.height, Color.white, null);
-    else {
-      g.setColor(Color.white);
-      g.fillRect(0,0, canvasSize.width, canvasSize.height);
-      g.setColor(Color.black);
+    Phind phind;
+    static Image backgroundImage;
+    boolean displayInfo;
+    
+    PhindTitle(Phind p) {
+    phind = p;
     }
 
-    // display the title information
-    if (displayInfo) {
-      String title = "Phind 2.0";
-      String author = "by Craig Nevill-Manning, Ian H. Witten, and Gordon Paynter";
-      String contact = "[email protected], {ihw.gwp}@cs.waikato.ac.nz";
-      String ref1 = "see \"Browsing in Digital Libraries: A Phrase-based Approach\"";
-      String ref2 = "by Nevill-Manning and friends in DL'97 for details.";
-      
-      g.setColor(Color.black);
-      int center = canvasSize.width / 2;
-      int y = 20;
-      
-      g.setFont(phind.boldFont);
-      paintLine(g, title, y, center);
-      y += (phind.fontSize + 10);
-      g.setFont(phind.plainFont);
-      paintLine(g, author, y, center);
-      y += (phind.fontSize + 5);
-      paintLine(g, contact, y, center);
-      y += (phind.fontSize + 10);
-      paintLine(g, ref1, y, center);
-      y += (phind.fontSize + 5);
-      paintLine(g, ref2, y, center);
+    public void update(Graphics g) {
+    paint(g);
     }
+
+    public void paint(Graphics g) {
+    Dimension canvasSize = size();
+    
+    // set the screen background
+    if (phind.showImage)
+        try {
+        g.drawImage(phind.backgroundImage, 
+                0, 0, canvasSize.width, canvasSize.height, Color.white, null);
+        } catch (Exception e) {
+        System.err.println("PhindTitle paint: "  + e);
+        }
+    else {
+        g.setColor(Color.white);
+        g.fillRect(0,0, canvasSize.width, canvasSize.height);
+        g.setColor(Color.black);
+    }
   }
-
-  void paintLine(Graphics g, String s, int y, int center) {
-    int x = center - (g.getFontMetrics().stringWidth(s) / 2);
-    g.drawString(s, x, y);
-  }
-
 }
 
  
+
+
+
+
+

trunk/gsdl/src/phind/client/ResultBox.java

@@ -67 +67 @@
     Panel label;
 
-    // Information about the query
+  // The key identifying the phrase displayed, with its text and the
+  // collection from which it is drawn
     String searchKey, searchPhrase;
     String searchCollection;
     
-    // Information about the result set
+  // The total frequency, expansion frequency, and document frequency
+  // of the phrase
+  int numberOfOccurances;
     int numberOfExpansions;
-    int expansionsRetrieved;
     int numberOfDocuments;
-    int documentsRetrieved;
+
+  // The number of phrases and documents retrieved, and the number of
+  // times the user has requested more phrases or documents.
+  int documentsRetrieved;
+  int expansionsRetrieved;
     int nextPhraseBlock;
     int nextDocumentBlock;
@@ -103 +109 @@
     if (prev != null) prev.next = this;
 
+    searchKey = key;
+    searchPhrase = phrase;
+    searchCollection = collect;
+
+    numberOfOccurances = -1;
     numberOfExpansions = -1;
+    numberOfDocuments = -1;
+
     expansionsRetrieved = 0;
-    numberOfDocuments = -1;
     documentsRetrieved = 0;
     nextPhraseBlock = 1;
     nextDocumentBlock = 1;
 
-    searchKey = key;
-    searchPhrase = phrase;
-    searchCollection = collect;
 
     setLayout(new BorderLayout());
-
 
     s = new Scrollbar(Scrollbar.VERTICAL);
@@ -176 +184 @@
     }
 
-
+    
+    // Look up a phrase
+    // Phrase lookups are passed on to the Phind applet itself.
     void lookupPhrase(String key, String phrase, int queryMode) {
     buffer = "";
@@ -264 +274 @@
     }
  
-    // The <expansionlist> tag
-    else if (buffer.startsWith("<expansionlist ")) {
+    // The <phinddata> tag introduces the dataset
+    else if (buffer.startsWith("<phinddata ")) {
         item = buffer.substring(0, eol);
         buffer = buffer.substring(eol + 1);
-        addExpansionListTag(item);
+        addPhinddataTag(item);
         return true;
-    }
- 
-    // The <documentlist> tag
-    else if (buffer.startsWith("<documentlist ")) {
-        item = buffer.substring(0, eol);
-        buffer = buffer.substring(eol + 1);
-        addDocumentListTag(item);
-        return true;
-    }
- 
-    // The <phinddata> tag introduces the dataset
-    else if (buffer.startsWith("<phinddata ")) {
-
     }
 
@@ -291 +288 @@
     }
     
+    // The <expansionlist> tag
+    else if (buffer.startsWith("<expansionlist ")) {
+
+    }
+ 
+    // The <documentlist> tag
+    else if (buffer.startsWith("<documentlist ")) {
+
+    }
+ 
     // Ignore the piece we've read
     item = buffer.substring(0, eol);
@@ -299 +306 @@
 
 
-    // Add an expansion list tag
-    //
-    // Given a string containing an XML expansinlist tag of the form:
-    //   <expansionlist length="5" start="0" end="5">
-    //   <expansionlist length="134" start="0" end="10">
+    // Add a phinddata tag
+    //
+    // Given a string containing an XML phinddata tag of the form:
+    //   <phinddata id="35" text="FOREST" df="797" ef="134">
     // Read the expansion information from the tag
     //
     // Return true if successful, otherwise false.
 
-    boolean addExpansionListTag( String line ) {
+    boolean addPhinddataTag( String line ) {
 
     // System.out.println( "addExpansionListTag: " + line);
 
-    String lenStr = "";
-    int length = 0;
+    String idStr = "", tfStr = "", efStr = "", dfStr = "";
+    int tf = 0, ef = 0, df = 0;
 
     // Break the tag down into its component parts
-    line = line.substring(15);
     int nextSplit;
         while (line.length() > 0) {
         line = line.trim();
 
-        // Read the overall length of the list
-        if (line.startsWith("length")) {
-        line = line.substring(8);
-        nextSplit = line.indexOf((int) '"');
-        if (nextSplit >= 1) {
-            lenStr = line.substring(0, nextSplit);
-            length = Integer.valueOf(lenStr).intValue();
+        // Read the phrase identifier
+        if (line.startsWith("id")) {
+        line = line.substring(4);
+        nextSplit = line.indexOf((int) '"');
+        if (nextSplit >= 1) {
+            idStr = line.substring(0, nextSplit);
+            line = line.substring(nextSplit + 1);
+        } else {
+            System.err.println("addExpansionListTag: error parsing: " + line);
+        }
+        } 
+        
+        // Read the total frequency
+        else if (line.startsWith("tf")) {
+        line = line.substring(4);
+        nextSplit = line.indexOf((int) '"');
+        if (nextSplit >= 1) {
+            tfStr = line.substring(0, nextSplit);
+            tf = Integer.valueOf(tfStr).intValue();
+            line = line.substring(nextSplit + 1);
+        } else {
+            System.err.println("addExpansionListTag: error parsing: " + line);
+        }
+        } 
+
+        // Read the expansion frequency
+        else if (line.startsWith("ef")) {
+        line = line.substring(4);
+        nextSplit = line.indexOf((int) '"');
+        if (nextSplit >= 1) {
+            efStr = line.substring(0, nextSplit);
+            ef = Integer.valueOf(efStr).intValue();
+            line = line.substring(nextSplit + 1);
+        } else {
+            System.err.println("addExpansionListTag: error parsing: " + line);
+        }
+        } 
+
+        // Read the document frequency
+        else if (line.startsWith("df")) {
+        line = line.substring(4);
+        nextSplit = line.indexOf((int) '"');
+        if (nextSplit >= 1) {
+            dfStr = line.substring(0, nextSplit);
+            df = Integer.valueOf(dfStr).intValue();
             line = line.substring(nextSplit + 1);
         } else {
@@ -345 +388 @@
     }
 
-    // Add the length data to the ResultBox
-    numberOfExpansions = length;
+    // Add the data to the ResultBox
+    searchKey = idStr;
+    numberOfOccurances = tf;
+    numberOfExpansions = ef;
+    numberOfDocuments = df;
     return true;
     }
@@ -455 +501 @@
 
 
-
-    // Add a document list tag
-    //
-    // Given a string containing an XML documentlist tag of the form:
-    //   <documentlist length="797" start="0" end="10">
-    // Read the expansion information from the tag
-    //
-    // Return true if successful, otherwise false.
-
-    boolean addDocumentListTag( String line ) {
-
-    // System.out.println( "addExpansionListTag: " + line);
-
-    String lenStr = "";
-    int length = 0;
-
-    // Break the tag down into its component parts
-    line = line.substring(13);
-    int nextSplit;
-        while (line.length() > 0) {
-        line = line.trim();
-
-        // Read the overall length of the list
-        if (line.startsWith("length")) {
-        line = line.substring(8);
-        nextSplit = line.indexOf((int) '"');
-        if (nextSplit >= 1) {
-            lenStr = line.substring(0, nextSplit);
-            length = Integer.valueOf(lenStr).intValue();
-            line = line.substring(nextSplit + 1);
-        } else {
-            System.err.println("addExpansionListTag: error parsing: " + line);
-        }
-        } 
-
-        // Read and ignore some other tag
-        else {
-        nextSplit = line.indexOf((int) ' ');
-        if (nextSplit >= 1) {
-            line = line.substring(nextSplit + 1);
-        } else {
-            line = "";
-        }
-        }
-    }
-
-    // Add the length data to the ResultBox
-    numberOfDocuments = length;
-    return true;
-    }
-
-
     // Add an document tag
     //
     // Given a string containing an XML document tag of the form:
-    //   <document num="2" hash="HASH424e64b811fdad933be69c" freq="1" title="CONTENS"/>
+    //   <document num="2" hash="HASH424e64b811fdad933be69c" freq="1" title="CONTENTS"/>
     //   <document num="3" hash="HASH01f08efd8752ad54ca0a99cf" freq="1" title="Tree mixtures"/>
     //

trunk/gsdl/src/phind/client/ResultCanvas.java

@@ -242 +242 @@
     // draw the background
     if (phind.showImage) {
-        g.drawImage(backgroundImage, 
-            leftMargin, 0, rightMargin, canvasSize.height, 
-            Color.white, null);
+        try {
+        g.drawImage(backgroundImage, 
+                leftMargin, 0, rightMargin, canvasSize.height, 
+                Color.white, null);
+        } catch (Exception e) {
+        phind.showImage = false;
+        System.err.println("ResultCanvas paint error: " + e); 
+        g.setColor(Color.white);
+        g.fillRect(0, 0, canvasSize.width, canvasSize.height);
+        }
     } else {
         g.setColor(Color.white);
@@ -296 +303 @@
         g.drawString(" " + Integer.toString(result.freq), secondColumn, y);
         }
-
-        // Write the expand button
-        //if (result.expansion > 0) {
-        //  g.drawString(" +", leftMargin, y);
-        //}
-
 
         if (result.isPhrase()) {
@@ -360 +361 @@
 
 
-    // Handle user input
+    // User interaction
+    //
+    // All interaction with the ResultCanvas is therough mouse clicks, and
+    // is handles in this method.  Note we ignore clicks that follow
+    // another too closely to avoid problems with slow connections.
     public boolean handleEvent(Event event) {
     

trunk/gsdl/src/phind/client/ResultDisplay.java

@@ -1 @@
-/* ResultDisplay
+/**********************************************************************
+ *
+ * ResultDisplay.java -- Phrase list holder for Phind java applet
+ *
+ * Copyright 1997-2000 Gordon W. Paynter
+ * Copyright 2000 The New Zealand Digital Library Project
+ *
+ * A component of the Greenstone digital library software
+ * from the New Zealand Digital Library Project at the
+ * University of Waikato, New Zealand.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ *********************************************************************/
 
-A ResultDisplay is a Panel that can display a single Component.
-ResultBoxes can be "chained" together with their "prev" and "next" 
-fields.  
+/*********************************************************************
+
+This class is used in the Phind java applet (Phind.java).
+
+A ResultDisplay is a Panel that can display a single Component, which will
+be a ResultBox or PhindTitle object.
+
+ResultBoxes can be "chained" together with their "prev" and "next" fields,
+allowing us to have an arbitrary number of "displays" in which to show
+phrase lists.
 
 Main methods:
-
 * emptyContents will remove the component and emptyAll the "next" display
 * display will add an item to the first (ie: most "prev") available box
 
+**********************************************************************/
 
-*/
 
 import java.awt.Panel;
@@ -33 +64 @@
 
     empty = true;
-    current = new PhindTitle(ph,false);
+    current = new PhindTitle(ph);
     add(current);
   }
@@ -42 +73 @@
     if (empty == false) {
       empty = true;
-      current = new PhindTitle(phind,false);
+      current = new PhindTitle(phind);
       removeAll();
       add(current);