JAL-2071 improvement to reduce webservice requests to Free Text Search (FTS) services...

[jalview.git] / src / jalview / fts / core / GFTSPanel.java

diff --git a/src/jalview/fts/core/GFTSPanel.java b/src/jalview/fts/core/GFTSPanel.java
index 2e50386..cae271d 100644 (file)
--- a/src/jalview/fts/core/GFTSPanel.java
+++ b/src/jalview/fts/core/GFTSPanel.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -22,9 +22,8 @@
 package jalview.fts.core;
 
 import jalview.fts.api.FTSDataColumnI;
-import jalview.fts.api.FTSRestClientI;
+import jalview.fts.api.GFTSPanelI;
 import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
-import jalview.fts.service.pdb.PDBFTSRestClient;
 import jalview.gui.Desktop;
 import jalview.gui.IProgressIndicator;
 import jalview.gui.JvSwingUtils;
@@ -36,6 +35,8 @@ import java.awt.CardLayout;
 import java.awt.Dimension;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.awt.event.FocusEvent;
+import java.awt.event.FocusListener;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
@@ -58,20 +59,23 @@ import javax.swing.JScrollPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
+import javax.swing.Timer;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
+import javax.swing.table.DefaultTableModel;
 
 /**
- * GUI layout for PDB Fetch Panel
+ * This class provides the swing GUI layout for FTS Panel and implements most of
+ * the contracts defined in GFSPanelI
  * 
  * @author tcnofoegbu
  *
  */
 
 @SuppressWarnings("serial")
-public abstract class GFTSPanel extends JPanel
+public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 {
   protected JInternalFrame mainFrame = new JInternalFrame(
           getFTSFrameTitle());
@@ -92,7 +96,7 @@ public abstract class GFTSPanel extends JPanel
 
   protected Collection<FTSDataColumnI> wantedFields;
 
-  protected JTable tbl_summary = new JTable()
+  private JTable tbl_summary = new JTable()
   {
     @Override
     public String getToolTipText(MouseEvent evt)
@@ -205,7 +209,7 @@ public abstract class GFTSPanel extends JPanel
         case KeyEvent.VK_ENTER: // enter key
           if (btn_ok.isEnabled())
           {
-            btn_ok_ActionPerformed();
+            okAction();
           }
           evt.consume();
           break;
@@ -256,7 +260,7 @@ public abstract class GFTSPanel extends JPanel
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        btn_ok_ActionPerformed();
+        okAction();
       }
     });
     btn_ok.addKeyListener(new KeyAdapter()
@@ -266,7 +270,7 @@ public abstract class GFTSPanel extends JPanel
       {
         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
         {
-          btn_ok_ActionPerformed();
+          okAction();
         }
       }
     });
@@ -324,7 +328,7 @@ public abstract class GFTSPanel extends JPanel
         }
         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
                 tooltipText));
-        txt_search_ActionPerformed();
+        searchAction();
       }
     });
 
@@ -353,24 +357,29 @@ public abstract class GFTSPanel extends JPanel
       }
     });
 
-    txt_search.getDocument().addDocumentListener(new DocumentListener()
+    final DeferredTextInputListener listener = new DeferredTextInputListener(
+            500,
+            new ActionListener()
+            {
+              @Override
+              public void actionPerformed(ActionEvent e)
+              {
+                searchAction();
+              }
+            }, false);
+    txt_search.getDocument().addDocumentListener(listener);
+    txt_search.addFocusListener(new FocusListener()
     {
       @Override
-      public void insertUpdate(DocumentEvent e)
+      public void focusGained(FocusEvent e)
       {
-        txt_search_ActionPerformed();
+        listener.start();
       }
 
       @Override
-      public void removeUpdate(DocumentEvent e)
+      public void focusLost(FocusEvent e)
       {
-        txt_search_ActionPerformed();
-      }
-
-      @Override
-      public void changedUpdate(DocumentEvent e)
-      {
-        txt_search_ActionPerformed();
+        listener.stop();
       }
     });
 
@@ -398,7 +407,7 @@ public abstract class GFTSPanel extends JPanel
           btn_back.setEnabled(false);
           btn_cancel.setEnabled(false);
           btn_ok.setEnabled(false);
-          previousWantedFields = PDBFTSRestClient.getInstance()
+          previousWantedFields = getFTSRestClient()
                   .getAllDefaulDisplayedDataColumns()
                   .toArray(new Object[0]);
         }
@@ -408,7 +417,7 @@ public abstract class GFTSPanel extends JPanel
           btn_cancel.setEnabled(true);
           if (wantedFieldsUpdated())
           {
-            txt_search_ActionPerformed();
+            searchAction();
           }
           else
           {
@@ -443,6 +452,47 @@ public abstract class GFTSPanel extends JPanel
     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 800, 400);
   }
 
+  public class DeferredTextInputListener implements DocumentListener
+  {
+    private final Timer swingTimer;
+
+    public DeferredTextInputListener(int timeOut, ActionListener listener,
+            boolean repeats)
+    {
+      swingTimer = new Timer(timeOut, listener);
+      swingTimer.setRepeats(repeats);
+    }
+
+    public void start()
+    {
+      swingTimer.start();
+    }
+
+    public void stop()
+    {
+      swingTimer.stop();
+    }
+
+    @Override
+    public void insertUpdate(DocumentEvent e)
+    {
+      swingTimer.restart();
+    }
+
+    @Override
+    public void removeUpdate(DocumentEvent e)
+    {
+      swingTimer.restart();
+    }
+
+    @Override
+    public void changedUpdate(DocumentEvent e)
+    {
+      swingTimer.restart();
+    }
+
+  }
+
   public boolean wantedFieldsUpdated()
   {
     if (previousWantedFields == null)
@@ -450,7 +500,7 @@ public abstract class GFTSPanel extends JPanel
       return true;
     }
 
-    return Arrays.equals(PDBFTSRestClient.getInstance()
+    return Arrays.equals(getFTSRestClient()
             .getAllDefaulDisplayedDataColumns()
             .toArray(new Object[0]), previousWantedFields) ? false
             : true;
@@ -575,12 +625,50 @@ public abstract class GFTSPanel extends JPanel
     worker.start();
   }
 
-  public abstract String getFTSFrameTitle();
+  @Override
+  public String getTypedText()
+  {
+    return txt_search.getText().trim();
+  }
+
+  @Override
+  public JTable getResultTable()
+  {
+    return tbl_summary;
+  }
+
+  public void reset()
+  {
+    lbl_loading.setVisible(false);
+    errorWarning.setLength(0);
+    lbl_warning.setVisible(false);
+    btn_ok.setEnabled(false);
+    mainFrame.setTitle(getFTSFrameTitle());
+    referesh();
+    tbl_summary.setModel(new DefaultTableModel());
+    tbl_summary.setVisible(false);
+  }
 
-  public abstract FTSRestClientI getFTSRestClient();
+  @Override
+  public void setErrorMessage(String message)
+  {
+    errorWarning.append(message);
+  }
 
-  public abstract void txt_search_ActionPerformed();
+  @Override
+  public void updateSearchFrameTitle(String title)
+  {
+    mainFrame.setTitle(title);
+  }
 
-  public abstract void btn_ok_ActionPerformed();
+  @Override
+  public void setSearchInProgress(Boolean isSearchInProgress)
+  {
+    lbl_loading.setVisible(isSearchInProgress);
+  }
+  public void referesh()
+  {
+    mainFrame.setTitle(getFTSFrameTitle());
+  }
 
 }