Merge branch 'develop' into groovy/JAL-2074_upgradeto2.4.4
[jalview.git] / src / jalview / fts / core / GFTSPanel.java
similarity index 64%
rename from src/jalview/jbgui/GPDBSearchPanel.java
rename to src/jalview/fts/core/GFTSPanel.java
index d640df8..cae271d 100644 (file)
@@ -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.
  * 
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 
-package jalview.jbgui;
+package jalview.fts.core;
 
+import jalview.fts.api.FTSDataColumnI;
+import jalview.fts.api.GFTSPanelI;
+import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
 import jalview.gui.Desktop;
+import jalview.gui.IProgressIndicator;
 import jalview.gui.JvSwingUtils;
-import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
+import jalview.gui.SequenceFetcher;
 import jalview.util.MessageManager;
-import jalview.ws.dbsources.PDBRestClient.PDBDocField;
 
 import java.awt.BorderLayout;
 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;
 import java.awt.event.MouseEvent;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
 
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
@@ -49,26 +59,30 @@ 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 GPDBSearchPanel extends JPanel
+public abstract class GFTSPanel extends JPanel implements GFTSPanelI
 {
-  protected String frameTitle = MessageManager
-          .getString("label.pdb_sequence_getcher");
+  protected JInternalFrame mainFrame = new JInternalFrame(
+          getFTSFrameTitle());
 
-  protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
+  protected IProgressIndicator progressIdicator;
 
-  protected JComboBox<PDBDocField> cmb_searchTarget = new JComboBox<PDBDocField>();
+  protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
 
   protected JButton btn_ok = new JButton();
 
@@ -78,7 +92,11 @@ public abstract class GPDBSearchPanel extends JPanel
 
   protected JTextField txt_search = new JTextField(20);
 
-  protected JTable tbl_summary = new JTable()
+  protected SequenceFetcher seqFetcher;
+
+  protected Collection<FTSDataColumnI> wantedFields;
+
+  private JTable tbl_summary = new JTable()
   {
     @Override
     public String getToolTipText(MouseEvent evt)
@@ -125,9 +143,6 @@ public abstract class GPDBSearchPanel extends JPanel
 
   private JTabbedPane tabbedPane = new JTabbedPane();
 
-  private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
-          PreferenceSource.SEARCH_SUMMARY);
-
   private JPanel pnl_actions = new JPanel();
 
   private JPanel pnl_results = new JPanel(new CardLayout());
@@ -136,9 +151,9 @@ public abstract class GPDBSearchPanel extends JPanel
 
   private BorderLayout mainLayout = new BorderLayout();
 
-  protected PDBDocField[] previousWantedFields;
+  protected Object[] previousWantedFields;
 
-  public GPDBSearchPanel()
+  public GFTSPanel()
   {
     try
     {
@@ -194,7 +209,7 @@ public abstract class GPDBSearchPanel extends JPanel
         case KeyEvent.VK_ENTER: // enter key
           if (btn_ok.isEnabled())
           {
-            btn_ok_ActionPerformed();
+            okAction();
           }
           evt.consume();
           break;
@@ -245,7 +260,7 @@ public abstract class GPDBSearchPanel extends JPanel
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        btn_ok_ActionPerformed();
+        okAction();
       }
     });
     btn_ok.addKeyListener(new KeyAdapter()
@@ -255,7 +270,7 @@ public abstract class GPDBSearchPanel extends JPanel
       {
         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
         {
-          btn_ok_ActionPerformed();
+          okAction();
         }
       }
     });
@@ -313,7 +328,7 @@ public abstract class GPDBSearchPanel extends JPanel
         }
         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
                 tooltipText));
-        txt_search_ActionPerformed();
+        searchAction();
       }
     });
 
@@ -342,24 +357,29 @@ public abstract class GPDBSearchPanel 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();
       }
     });
 
@@ -387,8 +407,9 @@ public abstract class GPDBSearchPanel extends JPanel
           btn_back.setEnabled(false);
           btn_cancel.setEnabled(false);
           btn_ok.setEnabled(false);
-          previousWantedFields = PDBDocFieldPreferences
-                  .getSearchSummaryFields().toArray(new PDBDocField[0]);
+          previousWantedFields = getFTSRestClient()
+                  .getAllDefaulDisplayedDataColumns()
+                  .toArray(new Object[0]);
         }
         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
         {
@@ -396,7 +417,7 @@ public abstract class GPDBSearchPanel extends JPanel
           btn_cancel.setEnabled(true);
           if (wantedFieldsUpdated())
           {
-            txt_search_ActionPerformed();
+            searchAction();
           }
           else
           {
@@ -408,7 +429,8 @@ public abstract class GPDBSearchPanel extends JPanel
     tabbedPane.addChangeListener(changeListener);
     tabbedPane.setPreferredSize(new Dimension(500, 300));
     tabbedPane.add(searchTabTitle, scrl_searchResult);
-    tabbedPane.add(configureCols, pdbDocFieldPrefs);
+    tabbedPane.add(configureCols, new FTSDataColumnPreferences(
+            PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
 
     pnl_actions.add(btn_back);
     pnl_actions.add(btn_ok);
@@ -427,7 +449,48 @@ public abstract class GPDBSearchPanel extends JPanel
     mainFrame.setVisible(true);
     mainFrame.setContentPane(this);
     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
-    Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
+    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()
@@ -437,8 +500,9 @@ public abstract class GPDBSearchPanel extends JPanel
       return true;
     }
 
-    return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
-            .toArray(new PDBDocField[0]), previousWantedFields) ? false
+    return Arrays.equals(getFTSRestClient()
+            .getAllDefaulDisplayedDataColumns()
+            .toArray(new Object[0]), previousWantedFields) ? false
             : true;
 
   }
@@ -455,7 +519,7 @@ public abstract class GPDBSearchPanel extends JPanel
     }
   }
 
-  public JComboBox<PDBDocField> getCmbSearchTarget()
+  public JComboBox<FTSDataColumnI> getCmbSearchTarget()
   {
     return cmb_searchTarget;
   }
@@ -470,16 +534,141 @@ public abstract class GPDBSearchPanel extends JPanel
     return mainFrame;
   }
 
-  public abstract void transferToSequenceFetcher(String ids);
+  protected void delayAndEnableActionButtons()
+  {
+    new Thread()
+    {
+      @Override
+      public void run()
+      {
+        try
+        {
+          Thread.sleep(1500);
+        } catch (InterruptedException e)
+        {
+          e.printStackTrace();
+        }
+        btn_ok.setEnabled(true);
+        btn_back.setEnabled(true);
+        btn_cancel.setEnabled(true);
+      }
+    }.start();
+  }
+
+  protected void checkForErrors()
+  {
+    lbl_warning.setVisible(false);
+    if (errorWarning.length() > 0)
+    {
+      lbl_loading.setVisible(false);
+      lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
+              errorWarning.toString()));
+      lbl_warning.setVisible(true);
+    }
+  }
+
+  protected void btn_back_ActionPerformed()
+  {
+    mainFrame.dispose();
+    new SequenceFetcher(progressIdicator);
+  }
+
+  protected void disableActionButtons()
+  {
+    btn_ok.setEnabled(false);
+    btn_back.setEnabled(false);
+    btn_cancel.setEnabled(false);
+  }
+
+  protected void btn_cancel_ActionPerformed()
+  {
+    mainFrame.dispose();
+  }
+
+  /**
+   * Populates search target combo-box options
+   */
+  public void populateCmbSearchTargetOptions()
+  {
+    List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
+    try
+    {
+      Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
+              .getSearchableDataColumns();
+      searchableTargets.addAll(foundFTSTargets);
+    } catch (Exception e)
+    {
+      e.printStackTrace();
+    }
+
+    Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
+    {
+      @Override
+      public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
+      {
+        return o1.getName().compareTo(o2.getName());
+      }
+    });
+
+    for (FTSDataColumnI searchTarget : searchableTargets)
+    {
+      cmb_searchTarget.addItem(searchTarget);
+    }
+  }
+
 
-  public abstract void txt_search_ActionPerformed();
+  public void transferToSequenceFetcher(String ids)
+  {
+    // mainFrame.dispose();
+    seqFetcher.getTextArea().setText(ids);
+    Thread worker = new Thread(seqFetcher);
+    worker.start();
+  }
 
-  public abstract void btn_ok_ActionPerformed();
+  @Override
+  public String getTypedText()
+  {
+    return txt_search.getText().trim();
+  }
 
-  public abstract void btn_back_ActionPerformed();
+  @Override
+  public JTable getResultTable()
+  {
+    return tbl_summary;
+  }
 
-  public abstract void btn_cancel_ActionPerformed();
+  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);
+  }
+
+  @Override
+  public void setErrorMessage(String message)
+  {
+    errorWarning.append(message);
+  }
+
+  @Override
+  public void updateSearchFrameTitle(String title)
+  {
+    mainFrame.setTitle(title);
+  }
 
-  public abstract void populateCmbSearchTargetOptions();
+  @Override
+  public void setSearchInProgress(Boolean isSearchInProgress)
+  {
+    lbl_loading.setVisible(isSearchInProgress);
+  }
+  public void referesh()
+  {
+    mainFrame.setTitle(getFTSFrameTitle());
+  }
 
 }