JAL-2071 architectural improvement for Plugable Free Text Search Services

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

diff --git a/src/jalview/jbgui/GPDBSearchPanel.java b/src/jalview/fts/core/GFTSPanel.java
similarity index 77%
rename from src/jalview/jbgui/GPDBSearchPanel.java
rename to src/jalview/fts/core/GFTSPanel.java
index d640df8..2e50386 100644 (file)
--- a/src/jalview/jbgui/GPDBSearchPanel.java
+++ b/src/jalview/fts/core/GFTSPanel.java
@@ -19,13 +19,17 @@
  * 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.FTSRestClientI;
+import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
+import jalview.fts.service.pdb.PDBFTSRestClient;
 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;
@@ -36,7 +40,12 @@ 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;
@@ -60,15 +69,16 @@ import javax.swing.event.DocumentListener;
  * @author tcnofoegbu
  *
  */
+
 @SuppressWarnings("serial")
-public abstract class GPDBSearchPanel extends JPanel
+public abstract class GFTSPanel extends JPanel
 {
-  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,6 +88,10 @@ public abstract class GPDBSearchPanel extends JPanel
 
   protected JTextField txt_search = new JTextField(20);
 
+  protected SequenceFetcher seqFetcher;
+
+  protected Collection<FTSDataColumnI> wantedFields;
+
   protected JTable tbl_summary = new JTable()
   {
     @Override
@@ -125,9 +139,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 +147,9 @@ public abstract class GPDBSearchPanel extends JPanel
 
   private BorderLayout mainLayout = new BorderLayout();
 
-  protected PDBDocField[] previousWantedFields;
+  protected Object[] previousWantedFields;
 
-  public GPDBSearchPanel()
+  public GFTSPanel()
   {
     try
     {
@@ -387,8 +398,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 = PDBFTSRestClient.getInstance()
+                  .getAllDefaulDisplayedDataColumns()
+                  .toArray(new Object[0]);
         }
         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
         {
@@ -408,7 +420,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 +440,7 @@ 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 boolean wantedFieldsUpdated()
@@ -437,8 +450,9 @@ public abstract class GPDBSearchPanel extends JPanel
       return true;
     }
 
-    return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
-            .toArray(new PDBDocField[0]), previousWantedFields) ? false
+    return Arrays.equals(PDBFTSRestClient.getInstance()
+            .getAllDefaulDisplayedDataColumns()
+            .toArray(new Object[0]), previousWantedFields) ? false
             : true;
 
   }
@@ -455,7 +469,7 @@ public abstract class GPDBSearchPanel extends JPanel
     }
   }
 
-  public JComboBox<PDBDocField> getCmbSearchTarget()
+  public JComboBox<FTSDataColumnI> getCmbSearchTarget()
   {
     return cmb_searchTarget;
   }
@@ -470,16 +484,103 @@ 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();
+  }
 
-  public abstract void txt_search_ActionPerformed();
+  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);
+    }
+  }
 
-  public abstract void btn_ok_ActionPerformed();
+  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 btn_back_ActionPerformed();
 
-  public abstract void btn_cancel_ActionPerformed();
+  public void transferToSequenceFetcher(String ids)
+  {
+    // mainFrame.dispose();
+    seqFetcher.getTextArea().setText(ids);
+    Thread worker = new Thread(seqFetcher);
+    worker.start();
+  }
+
+  public abstract String getFTSFrameTitle();
+
+  public abstract FTSRestClientI getFTSRestClient();
 
-  public abstract void populateCmbSearchTargetOptions();
+  public abstract void txt_search_ActionPerformed();
+
+  public abstract void btn_ok_ActionPerformed();
 
 }