JAL-1648 Implemented in-memory caching for FTS (Uniprot & PDB) and Finder
[jalview.git] / src / jalview / fts / core / GFTSPanel.java
index 30b6417..a581717 100644 (file)
@@ -28,6 +28,8 @@ import jalview.gui.Desktop;
 import jalview.gui.IProgressIndicator;
 import jalview.gui.JvSwingUtils;
 import jalview.gui.SequenceFetcher;
+import jalview.io.cache.AppCache;
+import jalview.io.cache.Cacheable;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -38,6 +40,8 @@ import java.awt.event.ActionListener;
 import java.awt.event.FocusAdapter;
 import java.awt.event.FocusEvent;
 import java.awt.event.FocusListener;
+import java.awt.event.ItemEvent;
+import java.awt.event.ItemListener;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
@@ -54,6 +58,7 @@ import java.util.List;
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
 import javax.swing.JComboBox;
+import javax.swing.JComponent;
 import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
 import javax.swing.JLabel;
@@ -61,7 +66,6 @@ import javax.swing.JPanel;
 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;
@@ -70,6 +74,7 @@ import javax.swing.event.DocumentListener;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.table.DefaultTableModel;
 import javax.swing.table.TableColumn;
+import javax.swing.text.JTextComponent;
 
 /**
  * This class provides the swing GUI layout for FTS Panel and implements most of
@@ -80,7 +85,7 @@ import javax.swing.table.TableColumn;
  */
 
 @SuppressWarnings("serial")
-public abstract class GFTSPanel extends JPanel implements GFTSPanelI
+public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
 {
   protected JInternalFrame mainFrame = new JInternalFrame(
           getFTSFrameTitle());
@@ -95,7 +100,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected JButton btn_cancel = new JButton();
 
-  protected JTextField txt_search = new JTextField(30);
+  protected JComboBox<String> txt_search;
 
   protected SequenceFetcher seqFetcher;
 
@@ -148,6 +153,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
           "###,###");
+
   private JTable tbl_summary = new JTable()
   {
     private boolean inLayout;
@@ -225,6 +231,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       return toolTipText;
     }
   };
+
   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 
   public GFTSPanel()
@@ -255,6 +262,12 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
    */
   private void jbInit() throws Exception
   {
+
+    txt_search = new JComboBox<String>();
+    txt_search.setEditable(true);
+    txt_search
+            .setPrototypeDisplayValue("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+    populateCmbSearchTargetOptions();
     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
             : getTempUserPrefs().get("FTSPanel.width");
     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
@@ -446,49 +459,52 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     scrl_searchResult.setPreferredSize(new Dimension(width, height));
 
     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
-    cmb_searchTarget.addActionListener(new ActionListener()
+    cmb_searchTarget.addItemListener(new ItemListener()
     {
       @Override
-      public void actionPerformed(ActionEvent e)
+      public void itemStateChanged(ItemEvent e)
       {
-        String tooltipText;
-        if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
-                .toString()))
-        {
-          tooltipText = MessageManager.getString("label.search_all");
-        }
-        else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
-                .getSelectedItem().toString()))
-        {
-          tooltipText = MessageManager
-                  .getString("label.separate_multiple_accession_ids");
-        }
-        else
+        if (e.getStateChange() == ItemEvent.SELECTED)
         {
-          tooltipText = MessageManager.formatMessage(
-                  "label.separate_multiple_query_values",
-                  new Object[] { getCmbSearchTarget().getSelectedItem()
-                          .toString() });
+          String tooltipText;
+          if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
+                  .toString()))
+          {
+            tooltipText = MessageManager.getString("label.search_all");
+          }
+          else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
+                  .getSelectedItem().toString()))
+          {
+            tooltipText = MessageManager
+                    .getString("label.separate_multiple_accession_ids");
+          }
+          else
+          {
+            tooltipText = MessageManager.formatMessage(
+                    "label.separate_multiple_query_values",
+                    new Object[] { getCmbSearchTarget().getSelectedItem()
+                            .toString() });
+          }
+          txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
+                  tooltipText));
+          searchAction(true);
         }
-        txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
-                tooltipText));
-        searchAction(true);
       }
     });
 
-    populateCmbSearchTargetOptions();
 
     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 
-    txt_search.addKeyListener(new KeyAdapter()
+    txt_search.getEditor().getEditorComponent()
+            .addKeyListener(new KeyAdapter()
     {
       @Override
       public void keyPressed(KeyEvent e)
       {
         if (e.getKeyCode() == KeyEvent.VK_ENTER)
         {
-          if (txt_search.getText() == null
-                  || txt_search.getText().isEmpty())
+          if (getTypedText() == null || getTypedText().isEmpty())
           {
             return;
           }
@@ -497,15 +513,14 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
           if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
                   .getSelectedItem().toString()))
           {
-            transferToSequenceFetcher(txt_search.getText());
+            transferToSequenceFetcher(getTypedText());
           }
         }
       }
     });
 
     final DeferredTextInputListener listener = new DeferredTextInputListener(
-            1500,
-            new ActionListener()
+            1500, new ActionListener()
             {
               @Override
               public void actionPerformed(ActionEvent e)
@@ -518,7 +533,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
                 }
               }
             }, false);
-    txt_search.getDocument().addDocumentListener(listener);
+    ((JTextComponent) txt_search.getEditor().getEditorComponent())
+            .getDocument().addDocumentListener(listener);
+
     txt_search.addFocusListener(new FocusListener()
     {
       @Override
@@ -530,7 +547,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       @Override
       public void focusLost(FocusEvent e)
       {
-//        listener.stop();
+        // listener.stop();
       }
     });
 
@@ -563,8 +580,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
           txt_search.setEnabled(false);
           cmb_searchTarget.setEnabled(false);
           previousWantedFields = getFTSRestClient()
-                  .getAllDefaultDisplayedFTSDataColumns()
-                  .toArray(new Object[0]);
+                  .getAllDefaultDisplayedFTSDataColumns().toArray(
+                          new Object[0]);
         }
         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
         {
@@ -634,17 +651,13 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 
   protected void closeAction()
   {
-    // System.out.println(">>>>>>>>>> closing internal frame!!!");
-    // System.out.println("width : " + this.getWidth());
-    // System.out.println("heigh : " + this.getHeight());
-    // System.out.println("x : " + mainFrame.getX());
-    // System.out.println("y : " + mainFrame.getY());
     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
     mainFrame.dispose();
   }
+
   public class DeferredTextInputListener implements DocumentListener
   {
     private final Timer swingTimer;
@@ -690,13 +703,12 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
   {
     if (previousWantedFields == null)
     {
-      return true;
+      return false;
     }
 
     return Arrays.equals(getFTSRestClient()
-            .getAllDefaultDisplayedFTSDataColumns()
-            .toArray(new Object[0]), previousWantedFields) ? false
-            : true;
+            .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
+            previousWantedFields) ? false : true;
 
   }
 
@@ -718,7 +730,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     return cmb_searchTarget;
   }
 
-  public JTextField getTxtSearch()
+  public JComboBox<String> getTxtSearch()
   {
     return txt_search;
   }
@@ -812,10 +824,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     }
   }
 
-
   public void transferToSequenceFetcher(String ids)
   {
-    // mainFrame.dispose();
     seqFetcher.getTextArea().setText(ids);
     Thread worker = new Thread(seqFetcher);
     worker.start();
@@ -824,7 +834,8 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
   @Override
   public String getTypedText()
   {
-    return txt_search.getText().trim();
+    return txt_search.getEditor().getItem() == null ? "" : txt_search
+            .getEditor().getItem().toString().trim();
   }
 
   @Override
@@ -925,12 +936,10 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     int[] selectedRows = resultTable.getSelectedRows();
     for (int summaryRow : selectedRows)
     {
-      String idStr = resultTable.getValueAt(summaryRow,
-              primaryKeyColIndex).toString();
+      String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
+              .toString();
       paginatorCart.add(idStr);
     }
-    // System.out.println("Paginator shopping cart size : "
-    // + paginatorCart.size());
   }
 
   public void updateSummaryTableSelections()
@@ -949,9 +958,7 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     {
       e.printStackTrace();
     }
-    // System.out.println(">>>>>> got here : 1");
     int totalRows = resultTable.getRowCount();
-    // resultTable.clearSelection();
     for (int row = 0; row < totalRows; row++)
     {
       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
@@ -962,11 +969,9 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
     }
     validateSelection();
   }
+
   public void refreshPaginatorState()
   {
-    // System.out.println("resultSet count : " + resultSetCount);
-    // System.out.println("offSet : " + offSet);
-    // System.out.println("page limit : " + pageLimit);
     setPrevPageButtonEnabled(false);
     setNextPageButtonEnabled(false);
     if (resultSetCount == 0 && pageLimit == 0)
@@ -982,9 +987,41 @@ public abstract class GFTSPanel extends JPanel implements GFTSPanelI
       setPrevPageButtonEnabled(true);
     }
   }
+
   public void referesh()
   {
     mainFrame.setTitle(getFTSFrameTitle());
   }
 
+
+  protected void fireCache()
+  {
+    AppCache.getInstance().updateCache(this);
+  }
+
+  @Override
+  public void init()
+  {
+    // reset();
+  }
+
+  @Override
+  public JComponent getNextFocusableElement()
+  {
+    return mainFrame;
+  }
+
+  @Override
+  public String getCacheKey()
+  {
+    return getCacheKey();
+  }
+
+  @Override
+  public JComboBox<String> getCacheComboBox()
+  {
+    return txt_search;
+  }
+
+
 }