X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fgui%2FSequenceFetcher.java;h=ae4fffd76457042ea5aa2b6252470454f371526d;hb=d23b0d22d59c3f8c0cea88f41f2361d7a4f12a94;hp=e25991335d3edd7167ccc2d4ccfd64f8105a09dd;hpb=32f233c6bf8f0715e35f1b6ed6025f7c30aa8573;p=jalview.git
diff --git a/src/jalview/gui/SequenceFetcher.java b/src/jalview/gui/SequenceFetcher.java
index e259913..ae4fffd 100755
--- a/src/jalview/gui/SequenceFetcher.java
+++ b/src/jalview/gui/SequenceFetcher.java
@@ -24,18 +24,19 @@ import jalview.api.FeatureSettingsModelI;
import jalview.bin.Cache;
import jalview.datamodel.AlignmentI;
import jalview.datamodel.DBRefEntry;
-import jalview.datamodel.SequenceFeature;
import jalview.datamodel.SequenceI;
+import jalview.fts.core.GFTSPanel;
import jalview.fts.service.pdb.PDBFTSPanel;
import jalview.fts.service.uniprot.UniprotFTSPanel;
+import jalview.io.FileFormatI;
import jalview.io.gff.SequenceOntologyI;
import jalview.util.DBRefUtils;
import jalview.util.MessageManager;
import jalview.util.Platform;
-import jalview.ws.dbsources.das.api.DasSourceRegistryI;
import jalview.ws.seqfetcher.DbSourceProxy;
import java.awt.BorderLayout;
+import java.awt.Component;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
@@ -43,58 +44,48 @@ import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collections;
+import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import javax.swing.JButton;
import javax.swing.JCheckBox;
+import javax.swing.JComboBox;
import javax.swing.JInternalFrame;
import javax.swing.JLabel;
-import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.SwingConstants;
-import javax.swing.tree.DefaultMutableTreeNode;
-public class SequenceFetcher extends JPanel implements Runnable
-{
- JLabel dbeg = new JLabel();
-
- JDatabaseTree database;
-
- JButton databaseButt;
-
- JLabel jLabel1 = new JLabel();
-
- JCheckBox replacePunctuation = new JCheckBox();
-
- JButton ok = new JButton();
-
- JButton clear = new JButton();
+import javajs.async.AsyncSwingWorker;
- JButton example = new JButton();
-
- JButton close = new JButton();
-
- JPanel jPanel1 = new JPanel();
+/**
+ * A panel where the use may choose a database source, and enter one or more
+ * accessions, to retrieve entries from the database.
+ *
+ * If the selected source is Uniprot or PDB, a free text search panel is opened
+ * instead to perform the search and selection.
+ */
+@SuppressWarnings("serial")
+public class SequenceFetcher extends JPanel
+{
- JTextArea textArea = new JTextArea();
+ JLabel exampleAccession;
- JScrollPane jScrollPane1 = new JScrollPane();
+ JComboBox database;
- JPanel jPanel2 = new JPanel();
+ JCheckBox replacePunctuation;
- JPanel jPanel3 = new JPanel();
+ JButton okBtn;
- JPanel jPanel4 = new JPanel();
+ JButton exampleBtn;
- BorderLayout borderLayout1 = new BorderLayout();
+ JButton closeBtn;
- BorderLayout borderLayout2 = new BorderLayout();
+ JButton backBtn;
- BorderLayout borderLayout3 = new BorderLayout();
+ JTextArea textArea;
JInternalFrame frame;
@@ -102,294 +93,118 @@ public class SequenceFetcher extends JPanel implements Runnable
AlignFrame alignFrame;
- StringBuffer result;
-
- final String noDbSelected = "-- Select Database --";
-
- private static jalview.ws.SequenceFetcher sfetch = null;
+ GFTSPanel parentSearchPanel;
- private static long lastDasSourceRegistry = -3;
+ IProgressIndicator progressIndicator;
- private static DasSourceRegistryI dasRegistry = null;
-
- private static boolean _initingFetcher = false;
-
- private static Thread initingThread = null;
-
- int debounceTrap = 0;
-
- public JTextArea getTextArea()
- {
- return textArea;
- }
+ volatile boolean _isConstructing = false;
/**
- * Blocking method that initialises and returns the shared instance of the
- * SequenceFetcher client
+ * Constructor given a client to receive any status or progress messages
+ * (currently either the Desktop, or an AlignFrame panel)
*
- * @param guiWindow
- * - where the initialisation delay message should be shown
- * @return the singleton instance of the sequence fetcher client
+ * @param guiIndic
*/
- public static jalview.ws.SequenceFetcher getSequenceFetcherSingleton(
- final IProgressIndicator guiWindow)
- {
- if (_initingFetcher && initingThread != null && initingThread.isAlive())
- {
- if (guiWindow != null)
- {
- guiWindow
- .setProgressBar(
- MessageManager
- .getString("status.waiting_sequence_database_fetchers_init"),
- Thread.currentThread().hashCode());
- }
- // initting happening on another thread - so wait around to see if it
- // finishes.
- while (_initingFetcher && initingThread != null
- && initingThread.isAlive())
- {
- try
- {
- Thread.sleep(10);
- } catch (Exception e)
- {
- }
- ;
- }
- if (guiWindow != null)
- {
- guiWindow
- .setProgressBar(
- MessageManager
- .getString("status.waiting_sequence_database_fetchers_init"),
- Thread.currentThread().hashCode());
- }
- }
- if (sfetch == null
- || dasRegistry != Cache.getDasSourceRegistry()
- || lastDasSourceRegistry != (Cache.getDasSourceRegistry()
- .getDasRegistryURL() + Cache
- .getDasSourceRegistry().getLocalSourceString())
- .hashCode())
- {
- _initingFetcher = true;
- initingThread = Thread.currentThread();
- /**
- * give a visual indication that sequence fetcher construction is occuring
- */
- if (guiWindow != null)
- {
- guiWindow.setProgressBar(MessageManager
- .getString("status.init_sequence_database_fetchers"),
- Thread.currentThread().hashCode());
- }
- dasRegistry = Cache.getDasSourceRegistry();
- dasRegistry.refreshSources();
-
- jalview.ws.SequenceFetcher sf = new jalview.ws.SequenceFetcher();
- if (guiWindow != null)
- {
- guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
- }
- lastDasSourceRegistry = (dasRegistry.getDasRegistryURL() + dasRegistry
- .getLocalSourceString()).hashCode();
- sfetch = sf;
- _initingFetcher = false;
- initingThread = null;
- }
- return sfetch;
- }
-
- private IProgressIndicator progressIndicator;
- private boolean _isConstructing=false;
-
- private List newAlframes = null;
-
public SequenceFetcher(IProgressIndicator guiIndic)
{
this(guiIndic, null, null);
}
+ /**
+ * Constructor with specified database and accession(s) to retrieve
+ *
+ * @param guiIndic
+ * @param selectedDb
+ * @param queryString
+ */
public SequenceFetcher(IProgressIndicator guiIndic,
final String selectedDb, final String queryString)
{
- this._isConstructing=true;
this.progressIndicator = guiIndic;
- final SequenceFetcher us = this;
- // launch initialiser thread
- Thread sf = new Thread(new Runnable()
- {
- @Override
- public void run()
- {
- if (getSequenceFetcherSingleton(progressIndicator) != null)
- {
- us.initGui(progressIndicator, selectedDb, queryString);
- us._isConstructing=false;
- }
- else
- {
- javax.swing.SwingUtilities.invokeLater(new Runnable()
- {
- @Override
- public void run()
- {
- JOptionPane
- .showInternalMessageDialog(
- Desktop.desktop,
- MessageManager
- .getString("warn.couldnt_create_sequence_fetcher_client"),
- MessageManager
- .getString("label.couldnt_create_sequence_fetcher"),
- JOptionPane.ERROR_MESSAGE);
- }
- });
+ this.guiWindow = progressIndicator;
- // raise warning dialog
- }
- }
- });
- sf.start();
- }
- /**
- * blocking call which creates a new sequence fetcher panel, configures it and presses the OK button with the given database and query.
- * @param database
- * @param query
- */
- public static List fetchAndShow(String database, String query)
- {
- final SequenceFetcher sf = new SequenceFetcher(Desktop.instance, database, query);
- while (sf._isConstructing)
+ if (progressIndicator instanceof AlignFrame)
{
- try { Thread.sleep(50);
- } catch (Exception q)
- {
- return Collections.EMPTY_LIST;
- }
+ alignFrame = (AlignFrame) progressIndicator;
}
- sf.newAlframes = new ArrayList();
- sf.run();
- return sf.newAlframes;
- }
-
- private class DatabaseAuthority extends DefaultMutableTreeNode
- {
- };
+ jbInit(selectedDb);
+ textArea.setText(queryString);
- private class DatabaseSource extends DefaultMutableTreeNode
- {
+ frame = new JInternalFrame();
+ frame.setContentPane(this);
+ Desktop.addInternalFrame(frame, getFrameTitle(), true, 400,
+ Platform.isAMacAndNotJS() ? 240 : 180);
+ }
- };
-
- /**
- * initialise the database and query for this fetcher panel
- *
- * @param selectedDb
- * - string that should correspond to a sequence fetcher
- * @param queryString
- * - string that will be entered in the query dialog
- * @return true if UI was configured with valid database and query string
- */
- protected boolean setInitialQuery(String selectedDb, String queryString)
+ private String getFrameTitle()
{
- if (selectedDb == null || selectedDb.trim().length() == 0)
- {
- return false;
- }
- try
- {
- List sp = sfetch.getSourceProxy(selectedDb);
- if (sp == null || sp.size() != 1)
- {
- System.err.println("Ignoring fetch parameter db='" + selectedDb
- + "'");
- return false;
- }
- database.selection = sp;
- textArea.setText(queryString);
- } catch (Exception q)
- {
- System.err.println("Ignoring fetch parameter db='" + selectedDb
- + "' and query='" + queryString + "'");
- return false;
- }
- return true;
+ return ((alignFrame == null)
+ ? MessageManager.getString("label.new_sequence_fetcher")
+ : MessageManager
+ .getString("label.additional_sequence_fetcher"));
}
- /**
- * called by thread spawned by constructor
- *
- * @param guiWindow
- * @param queryString
- * @param selectedDb
- */
- private void initGui(IProgressIndicator guiWindow, String selectedDb,
- String queryString)
+ private void jbInit(String selectedDb)
{
- this.guiWindow = guiWindow;
- if (guiWindow instanceof AlignFrame)
- {
- alignFrame = (AlignFrame) guiWindow;
- }
- database = new JDatabaseTree(sfetch);
- try
- {
- jbInit();
- /*
- * configure the UI with any query parameters we were called with
- */
- if (!setInitialQuery(selectedDb, queryString))
- {
- /*
- * none provided, so show the database chooser
- */
- database.waitForInput();
- }
- } catch (Exception ex)
- {
- ex.printStackTrace();
- }
+ this.setLayout(new BorderLayout());
- frame = new JInternalFrame();
- frame.setContentPane(this);
- if (Platform.isAMac())
+ database = new JComboBox<>();
+ database.setFont(JvSwingUtils.getLabelFont());
+ database.setPrototypeDisplayValue("ENSEMBLGENOMES ");
+ String[] sources = jalview.ws.SequenceFetcher.getInstance()
+ .getSupportedDb();
+ Arrays.sort(sources, String.CASE_INSENSITIVE_ORDER);
+ database.addItem(MessageManager.getString("action.select_ddbb"));
+ for (String source : sources)
{
- Desktop.addInternalFrame(frame, getFrameTitle(), false, 400, 240);
+ database.addItem(source);
}
- else
+ database.setSelectedItem(selectedDb);
+ if (database.getSelectedIndex() == -1)
{
- Desktop.addInternalFrame(frame, getFrameTitle(), false, 400, 180);
+ database.setSelectedIndex(0);
}
- }
-
- private String getFrameTitle()
- {
- return ((alignFrame == null) ? MessageManager
- .getString("label.new_sequence_fetcher") : MessageManager
- .getString("label.additional_sequence_fetcher"));
- }
+ database.setMaximumRowCount(database.getItemCount());
+ database.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent e)
+ {
+ String currentSelection = (String) database.getSelectedItem();
+ updateExampleQuery(currentSelection);
- private void jbInit() throws Exception
- {
- this.setLayout(borderLayout2);
+ if ("pdb".equalsIgnoreCase(currentSelection))
+ {
+ frame.dispose();
+ new PDBFTSPanel(SequenceFetcher.this);
+ }
+ else if ("uniprot".equalsIgnoreCase(currentSelection))
+ {
+ frame.dispose();
+ new UniprotFTSPanel(SequenceFetcher.this);
+ }
+ else
+ {
+ otherSourceAction();
+ }
+ }
+ });
- database.setFont(JvSwingUtils.getLabelFont());
- dbeg.setFont(new java.awt.Font("Verdana", Font.BOLD, 11));
- jLabel1.setFont(new java.awt.Font("Verdana", Font.ITALIC, 11));
- jLabel1.setHorizontalAlignment(SwingConstants.CENTER);
- jLabel1.setText(MessageManager
+ exampleAccession = new JLabel("");
+ exampleAccession.setFont(new Font("Verdana", Font.BOLD, 11));
+ JLabel jLabel1 = new JLabel(MessageManager
.getString("label.separate_multiple_accession_ids"));
-
- replacePunctuation.setHorizontalAlignment(SwingConstants.CENTER);
- replacePunctuation
- .setFont(new java.awt.Font("Verdana", Font.ITALIC, 11));
- replacePunctuation.setText(MessageManager
- .getString("label.replace_commas_semicolons"));
- ok.setText(MessageManager.getString("action.ok"));
- ok.addActionListener(new ActionListener()
+ jLabel1.setFont(new Font("Verdana", Font.ITALIC, 11));
+ jLabel1.setHorizontalAlignment(SwingConstants.LEFT);
+
+ replacePunctuation = new JCheckBox(
+ MessageManager.getString("label.replace_commas_semicolons"));
+ replacePunctuation.setHorizontalAlignment(SwingConstants.LEFT);
+ replacePunctuation.setFont(new Font("Verdana", Font.ITALIC, 11));
+ okBtn = new JButton(MessageManager.getString("action.ok"));
+ okBtn.addActionListener(new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
@@ -397,7 +212,7 @@ public class SequenceFetcher extends JPanel implements Runnable
ok_actionPerformed();
}
});
- clear.setText(MessageManager.getString("action.clear"));
+ JButton clear = new JButton(MessageManager.getString("action.clear"));
clear.addActionListener(new ActionListener()
{
@Override
@@ -407,8 +222,8 @@ public class SequenceFetcher extends JPanel implements Runnable
}
});
- example.setText(MessageManager.getString("label.example"));
- example.addActionListener(new ActionListener()
+ exampleBtn = new JButton(MessageManager.getString("label.example"));
+ exampleBtn.addActionListener(new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
@@ -416,8 +231,8 @@ public class SequenceFetcher extends JPanel implements Runnable
example_actionPerformed();
}
});
- close.setText(MessageManager.getString("action.close"));
- close.addActionListener(new ActionListener()
+ closeBtn = new JButton(MessageManager.getString("action.cancel"));
+ closeBtn.addActionListener(new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
@@ -425,384 +240,587 @@ public class SequenceFetcher extends JPanel implements Runnable
close_actionPerformed(e);
}
});
- textArea.setFont(JvSwingUtils.getLabelFont());
- textArea.setLineWrap(true);
- textArea.addKeyListener(new KeyAdapter()
+ backBtn = new JButton(MessageManager.getString("action.back"));
+ backBtn.addActionListener(new ActionListener()
{
@Override
- public void keyPressed(KeyEvent e)
+ public void actionPerformed(ActionEvent e)
{
- if (e.getKeyCode() == KeyEvent.VK_ENTER)
- {
- ok_actionPerformed();
- }
+ parentSearchPanel.btn_back_ActionPerformed();
}
});
- jPanel3.setLayout(borderLayout1);
- borderLayout1.setVgap(5);
- jPanel1.add(ok);
- jPanel1.add(example);
- jPanel1.add(clear);
- jPanel1.add(close);
- jPanel3.add(jPanel2, java.awt.BorderLayout.CENTER);
- jPanel2.setLayout(borderLayout3);
- databaseButt = /*database.getDatabaseSelectorButton();
- final JButton viewdbs =*/new JButton(
- MessageManager.getString("action.select_ddbb"));
- databaseButt.addActionListener(new ActionListener()
- {
+ // back not visible unless embedded
+ backBtn.setVisible(false);
- @Override
- public void actionPerformed(ActionEvent arg0)
- {
- hidePanel();
- database.showDialog();
- }
- });
- databaseButt.setFont(JvSwingUtils.getLabelFont());
- database.addActionListener(new ActionListener()
+ textArea = new JTextArea();
+ textArea.setFont(JvSwingUtils.getLabelFont());
+ textArea.setLineWrap(true);
+ textArea.addKeyListener(new KeyAdapter()
{
@Override
- public void actionPerformed(ActionEvent e)
+ public void keyPressed(KeyEvent e)
{
- debounceTrap++;
- String currentSelection = database.getSelectedItem();
- if (currentSelection == null)
- {
- close_actionPerformed(null);
- }
-
- showPanel();
-
- if (currentSelection.equalsIgnoreCase("pdb")
- && (database.action == KeyEvent.VK_ENTER || ((debounceTrap % 2) == 0)))
- {
- pdbSourceAction();
- }
- else if (currentSelection.equalsIgnoreCase("uniprot")
- && (database.action == KeyEvent.VK_ENTER || ((debounceTrap % 2) == 0)))
- {
- uniprotSourceAction();
- }
- else
+ if (e.getKeyCode() == KeyEvent.VK_ENTER)
{
- otherSourceAction();
+ ok_actionPerformed();
}
- database.action = -1;
}
});
- dbeg.setText("");
- jPanel2.add(databaseButt, java.awt.BorderLayout.NORTH);
- jPanel2.add(dbeg, java.awt.BorderLayout.CENTER);
+ JPanel actionPanel = new JPanel();
+ actionPanel.add(backBtn);
+ actionPanel.add(exampleBtn);
+ actionPanel.add(clear);
+ actionPanel.add(okBtn);
+ actionPanel.add(closeBtn);
+
+ JPanel databasePanel = new JPanel();
+ databasePanel.setLayout(new BorderLayout());
+ databasePanel.add(database, BorderLayout.NORTH);
+ databasePanel.add(exampleAccession, BorderLayout.CENTER);
JPanel jPanel2a = new JPanel(new BorderLayout());
- jPanel2a.add(jLabel1, java.awt.BorderLayout.NORTH);
- jPanel2a.add(replacePunctuation, java.awt.BorderLayout.SOUTH);
- jPanel2.add(jPanel2a, java.awt.BorderLayout.SOUTH);
- // jPanel2.setPreferredSize(new Dimension())
- jPanel3.add(jScrollPane1, java.awt.BorderLayout.CENTER);
- this.add(jPanel1, java.awt.BorderLayout.SOUTH);
- this.add(jPanel3, java.awt.BorderLayout.CENTER);
- this.add(jPanel2, java.awt.BorderLayout.NORTH);
+ jPanel2a.add(jLabel1, BorderLayout.NORTH);
+ jPanel2a.add(replacePunctuation, BorderLayout.SOUTH);
+ databasePanel.add(jPanel2a, BorderLayout.SOUTH);
+
+ JPanel idsPanel = new JPanel();
+ idsPanel.setLayout(new BorderLayout(0, 5));
+ JScrollPane jScrollPane1 = new JScrollPane();
jScrollPane1.getViewport().add(textArea);
- }
+ idsPanel.add(jScrollPane1, BorderLayout.CENTER);
- private void pdbSourceAction()
- {
- databaseButt.setText(database.getSelectedItem());
- new PDBFTSPanel(this);
- frame.dispose();
+ this.add(actionPanel, BorderLayout.SOUTH);
+ this.add(idsPanel, BorderLayout.CENTER);
+ this.add(databasePanel, BorderLayout.NORTH);
}
- private void uniprotSourceAction()
- {
- databaseButt.setText(database.getSelectedItem());
- new UniprotFTSPanel(this);
- frame.dispose();
- }
- private void otherSourceAction()
+ /**
+ * Answers a semi-colon-delimited string with the example query or queries for
+ * the selected database
+ *
+ * @param db
+ * @return
+ */
+ protected String getExampleQueries(String db)
{
- try
+ StringBuilder sb = new StringBuilder();
+ HashSet hs = new HashSet<>();
+ for (DbSourceProxy dbs : jalview.ws.SequenceFetcher.getInstance()
+ .getSourceProxy(db))
{
- databaseButt.setText(database.getSelectedItem()
- + (database.getSelectedSources().size() > 1 ? " (and "
- + database.getSelectedSources().size() + " others)"
- : ""));
- String eq = database.getExampleQueries();
- dbeg.setText(MessageManager.formatMessage(
- "label.example_query_param", new String[] { eq }));
- boolean enablePunct = !(eq != null && eq.indexOf(",") > -1);
- for (DbSourceProxy dbs : database.getSelectedSources())
+ String tq = dbs.getTestQuery();
+ if (hs.add(tq)) // not a duplicate source
{
- if (dbs instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)
+ if (sb.length() > 0)
{
- enablePunct = false;
- break;
+ sb.append(";");
}
+ sb.append(tq);
}
+ }
+ return sb.toString();
+ }
+
+ /**
+ * Action on selecting a database other than Uniprot or PDB is to enable or
+ * disable 'Replace commas', and await input in the query field
+ */
+ protected void otherSourceAction()
+ {
+ try
+ {
+ String eq = exampleAccession.getText();
+ // TODO this should be a property of the SequenceFetcher whether commas
+ // are allowed in the IDs...
+
+ boolean enablePunct = !(eq != null && eq.indexOf(",") > -1);
replacePunctuation.setEnabled(enablePunct);
} catch (Exception ex)
{
- dbeg.setText("");
+ exampleAccession.setText("");
replacePunctuation.setEnabled(true);
}
- jPanel2.repaint();
+ repaint();
+ }
+
+ /**
+ * Sets the text of the example query to incorporate the example accession
+ * provided by the selected database source
+ *
+ * @param selectedDatabase
+ * @return
+ */
+ protected String updateExampleQuery(String selectedDatabase)
+ {
+ String eq = getExampleQueries(selectedDatabase);
+ exampleAccession.setText(MessageManager
+ .formatMessage("label.example_query_param", new String[]
+ { eq }));
+ return eq;
}
+ /**
+ * Action on clicking the 'Example' button is to write the example accession
+ * as the query text field value
+ */
protected void example_actionPerformed()
{
- DbSourceProxy db = null;
- try
- {
- textArea.setText(database.getExampleQueries());
- } catch (Exception ex)
- {
- }
- jPanel3.repaint();
+ String eq = getExampleQueries((String) database.getSelectedItem());
+ textArea.setText(eq);
+ repaint();
}
+ /**
+ * Clears the query input field
+ */
protected void clear_actionPerformed()
{
textArea.setText("");
- jPanel3.repaint();
+ repaint();
}
- public void close_actionPerformed(ActionEvent e)
+ /**
+ * Action on Close button is to close this frame, and also (if it is embedded
+ * in a search panel) to close the search panel
+ *
+ * @param e
+ */
+ protected void close_actionPerformed(ActionEvent e)
{
try
{
frame.setClosed(true);
+ if (parentSearchPanel != null)
+ {
+ parentSearchPanel.btn_cancel_ActionPerformed();
+ }
} catch (Exception ex)
{
}
}
+ /**
+ * Action on OK is to start the fetch for entered accession(s)
+ */
public void ok_actionPerformed()
{
- databaseButt.setEnabled(false);
- example.setEnabled(false);
+ /*
+ * tidy inputs and check there is something to search for
+ */
+ String t0 = textArea.getText();
+ String text = t0.trim();
+ if (replacePunctuation.isEnabled() && replacePunctuation.isSelected())
+ {
+ text = text.replace(",", ";");
+ }
+ text = text.replaceAll("(\\s|[; ])+", ";");
+ if (!t0.equals(text))
+ {
+ textArea.setText(text);
+ }
+ if (text.isEmpty())
+ {
+ // todo i18n
+ showErrorMessage(
+ "Please enter a (semi-colon separated list of) database id(s)");
+ resetDialog();
+ return;
+ }
+ exampleBtn.setEnabled(false);
textArea.setEnabled(false);
- ok.setEnabled(false);
- close.setEnabled(false);
-
- Thread worker = new Thread(this);
- worker.start();
+ okBtn.setEnabled(false);
+ closeBtn.setEnabled(false);
+ backBtn.setEnabled(false);
+ fetch(null, true);
}
- private void resetDialog()
+ public void fetch(String ids, boolean isAsync)
{
- databaseButt.setEnabled(true);
- example.setEnabled(true);
- textArea.setEnabled(true);
- ok.setEnabled(true);
- close.setEnabled(true);
- }
-
- @Override
- public void run()
- {
- String error = "";
- if (!database.hasSelection())
- {
- error += "Please select the source database\n";
- }
- // TODO: make this transformation more configurable
- com.stevesoft.pat.Regex empty;
- if (replacePunctuation.isEnabled() && replacePunctuation.isSelected())
+ if (ids == null)
{
- empty = new com.stevesoft.pat.Regex(
- // replace commas and spaces with a semicolon
- "(\\s|[,; ])+", ";");
+ ids = textArea.getText();
}
else
{
- // just turn spaces and semicolons into single semicolons
- empty = new com.stevesoft.pat.Regex("(\\s|[; ])+", ";");
+ textArea.setText(ids);
}
- textArea.setText(empty.replaceAll(textArea.getText()));
- // see if there's anthing to search with
- if (!new com.stevesoft.pat.Regex("[A-Za-z0-9_.]").search(textArea
- .getText()))
+ Component parent = null; // or this
+ String title = null; // or some title for the progress monitor
+ int min = AsyncFetchTask.STATE_INIT;
+ int max = AsyncFetchTask.STATE_DONE;
+ int msDelay = (isAsync ? 5 : 0);
+ new AsyncFetchTask(ids, parent, title, msDelay, min, max).execute();
+ }
+
+
+ protected void resetDialog()
+ {
+ exampleBtn.setEnabled(true);
+ textArea.setEnabled(true);
+ okBtn.setEnabled(true);
+ closeBtn.setEnabled(true);
+ backBtn.setEnabled(parentSearchPanel != null);
+ }
+
+ /**
+ * This asynchronous class allows for a single-threaded state machine
+ * SwingWorker to process a list of requests from multiple sources.
+ *
+ * A standard ProcessMonitor could be attached to this task, but it is
+ * currently not.
+ *
+ * @author hansonr
+ *
+ */
+ private class AsyncFetchTask extends AsyncSwingWorker
+ {
+
+ protected boolean addToLast = false;
+
+ protected List aresultq = new ArrayList<>();
+
+ protected List presultTitle = new ArrayList<>();
+
+ protected List presult = new ArrayList<>();
+
+ protected List aresult = new ArrayList<>();
+
+ protected FeatureSettingsModelI preferredFeatureColours = null;
+
+ protected List sources;
+
+ protected Iterator sourceIterator;
+
+ protected String[] fetchArray;
+
+ protected List fetchList;
+
+ protected Iterator fetchIterator;
+
+ protected int fetchCount;
+
+ protected DbSourceProxy source;
+
+ protected String ids;
+
+ protected long myID;
+
+ protected boolean isAsync;
+
+ protected Throwable taskError;
+
+ public AsyncFetchTask(String ids, Component owner, String title,
+ int delayMillis,
+ int min, int max)
{
- error += "Please enter a (semi-colon separated list of) database id(s)";
+ super(owner, title, delayMillis, min, max);
+ this.ids = ids;
+ isAsync = (delayMillis != 0);
+ myID = Thread.currentThread().getId();
}
- if (error.length() > 0)
+
+ @Override
+ public void initAsync()
{
- showErrorMessage(error);
- resetDialog();
- return;
+ sources = jalview.ws.SequenceFetcher.getInstance()
+ .getSourceProxy((String) database.getSelectedItem());
+ sourceIterator = sources.iterator();
+ fetchArray = ids.trim().split(";");
+ fetchList = Arrays.asList(fetchArray);
}
- // TODO: Refactor to GUI independent code and write tests.
- // indicate if successive sources should be merged into one alignment.
- boolean addToLast = false;
- List aresultq = new ArrayList();
- List presultTitle = new ArrayList();
- List presult = new ArrayList();
- List aresult = new ArrayList();
- Iterator proxies = database.getSelectedSources()
- .iterator();
- String[] qries;
- List nextFetch = Arrays.asList(qries = textArea.getText()
- .split(";"));
- Iterator en = Arrays.asList(new String[0]).iterator();
- int nqueries = qries.length;
-
- FeatureSettingsModelI preferredFeatureColours = null;
- while (proxies.hasNext() && (en.hasNext() || nextFetch.size() > 0))
- {
- if (!en.hasNext() && nextFetch.size() > 0)
- {
- en = nextFetch.iterator();
- nqueries = nextFetch.size();
- // save the remaining queries in the original array
- qries = nextFetch.toArray(new String[nqueries]);
- nextFetch = new ArrayList();
- }
- DbSourceProxy proxy = proxies.next();
- try
+ private final static int STATE_INIT = 0;
+
+ private final static int STATE_NEXT_SOURCE = 10;
+
+ private final static int STATE_FETCH_SINGLE = 30;
+
+ private final static int STATE_FETCH_MULTIPLE = 40;
+
+ private final static int STATE_PROCESS = 50;
+
+ private final static int STATE_PARSE_RESULTS = 80;
+
+ private final static int STATE_DONE = 100;
+
+ protected static final int STATE_TASK_ERROR = 99;
+
+ @Override
+ public int doInBackgroundAsync(int progress)
+ {
+ System.out.println("SequenceFetcher.AsyncFetchTask " + isAsync + " "
+ + progress + " "
+ + taskError);
+ switch (progress)
{
- // update status
- guiWindow
- .setProgressBar(MessageManager.formatMessage(
- "status.fetching_sequence_queries_from",
- new String[] {
- Integer.valueOf(nqueries).toString(),
- proxy.getDbName() }), Thread.currentThread()
- .hashCode());
- if (proxy.getMaximumQueryCount() == 1)
+ case STATE_INIT:
+ case STATE_NEXT_SOURCE:
+ boolean doneFetching = (fetchIterator == null
+ || !fetchIterator.hasNext());
+ boolean havePending = (fetchList.size() > 0);
+ if (!sourceIterator.hasNext() || doneFetching && !havePending)
+ {
+ showProgress((presult.size() > 0)
+ ? MessageManager.getString("status.parsing_results")
+ : MessageManager.getString("status.processing"));
+ return STATE_PARSE_RESULTS;
+ }
+ source = sourceIterator.next();
+ if (doneFetching)
+ {
+ // if we are here, we must have some pending still
+ fetchCount = fetchList.size();
+ fetchIterator = fetchList.iterator();
+ // save the remaining queries in the original array
+ fetchArray = fetchList.toArray(new String[fetchCount]);
+ // and clear the
+ fetchList = new ArrayList<>();
+ }
+ showProgress(MessageManager.formatMessage(
+ "status.fetching_sequence_queries_from", new String[]
+ { Integer.valueOf(fetchCount).toString(),
+ source.getDbName() }));
+ return (source.getMaximumQueryCount() == 1 ? STATE_FETCH_SINGLE
+ : STATE_FETCH_MULTIPLE);
+ case STATE_FETCH_SINGLE:
+ if (fetchIterator.hasNext())
{
- /*
- * proxy only handles one accession id at a time
- */
- while (en.hasNext())
+ return runSubtask(new Runnable()
{
- String acc = en.next();
- if (!fetchSingleAccession(proxy, acc, aresultq, aresult))
+
+ @Override
+ public void run()
{
- nextFetch.add(acc);
+ // source only handles one accession id at a time
+ try
+ {
+ if (!isAsync)
+ {
+ // for CrossRef2xmlTest only; to "allow the server to breathe"
+ // (but we are doing that already when isAsync is true)
+ Thread.sleep(5);
+ }
+ String notFound = fetchSingleAccession(source,
+ fetchIterator.next(), aresultq, aresult);
+ if (notFound != null)
+ {
+ fetchList.add(notFound);
+ }
+ } catch (Throwable e)
+ {
+ taskError = e;
+ }
}
- }
+ });
}
- else
+ return STATE_PROCESS;
+ case STATE_FETCH_MULTIPLE:
+ // proxy can fetch multiple accessions at one time
+ setProgressAsync(STATE_PROCESS);
+ return runSubtask(new Runnable()
{
- /*
- * proxy can fetch multiple accessions at one time
- */
- fetchMultipleAccessions(proxy, en, aresultq, aresult, nextFetch);
- }
- } catch (Exception e)
- {
- showErrorMessage("Error retrieving " + textArea.getText()
- + " from " + database.getSelectedItem());
- // error
- // +="Couldn't retrieve sequences from "+database.getSelectedItem();
- System.err.println("Retrieval failed for source ='"
- + database.getSelectedItem() + "' and query\n'"
- + textArea.getText() + "'\n");
- e.printStackTrace();
- } catch (OutOfMemoryError e)
- {
- showErrorMessage("Out of Memory when retrieving "
- + textArea.getText()
- + " from "
- + database.getSelectedItem()
- + "\nPlease see the Jalview FAQ for instructions for increasing the memory available to Jalview.\n");
- e.printStackTrace();
- } catch (Error e)
- {
- showErrorMessage("Serious Error retrieving " + textArea.getText()
- + " from " + database.getSelectedItem());
- e.printStackTrace();
- }
- // Stack results ready for opening in alignment windows
- if (aresult != null && aresult.size() > 0)
- {
- FeatureSettingsModelI proxyColourScheme = proxy
- .getFeatureColourScheme();
- if (proxyColourScheme != null)
- {
- preferredFeatureColours = proxyColourScheme;
- }
+ @Override
+ public void run()
+ {
+ try
+ {
+ fetchMultipleAccessions(source, fetchIterator, aresultq,
+ aresult, fetchList);
+ } catch (Throwable e)
+ {
+ taskError = e;
+ }
+ }
- AlignmentI ar = null;
- if (proxy.isAlignmentSource())
+ });
+ case STATE_PROCESS:
+ // Stack results ready for opening in alignment windows
+ if (aresult != null && aresult.size() > 0)
{
- addToLast = false;
- // new window for each result
- while (aresult.size() > 0)
+ FeatureSettingsModelI proxyColourScheme = source
+ .getFeatureColourScheme();
+ if (proxyColourScheme != null)
{
- presult.add(aresult.remove(0));
- presultTitle.add(aresultq.remove(0) + " "
- + getDefaultRetrievalTitle());
+ preferredFeatureColours = proxyColourScheme;
}
- }
- else
- {
- String titl = null;
- if (addToLast && presult.size() > 0)
+
+ AlignmentI ar = null;
+ if (source.isAlignmentSource())
{
- ar = presult.remove(presult.size() - 1);
- titl = presultTitle.remove(presultTitle.size() - 1);
+ addToLast = false;
+ // new window for each result
+ while (aresult.size() > 0)
+ {
+ presult.add(aresult.remove(0));
+ presultTitle.add(aresultq.remove(0) + " "
+ + getDefaultRetrievalTitle());
+ }
}
- // concatenate all results in one window
- while (aresult.size() > 0)
+ else
{
- if (ar == null)
+ String titl = null;
+ if (addToLast && presult.size() > 0)
{
- ar = aresult.remove(0);
+ ar = presult.remove(presult.size() - 1);
+ titl = presultTitle.remove(presultTitle.size() - 1);
}
- else
+ // concatenate all results in one window
+ while (aresult.size() > 0)
{
- ar.append(aresult.remove(0));
+ if (ar == null)
+ {
+ ar = aresult.remove(0);
+ }
+ else
+ {
+ ar.append(aresult.remove(0));
+ }
}
+ addToLast = true;
+ presult.add(ar);
+ presultTitle.add(titl);
}
- addToLast = true;
- presult.add(ar);
- presultTitle.add(titl);
}
+ showProgress(MessageManager.getString("status.finshed_querying"));
+ return STATE_NEXT_SOURCE;
+ case STATE_PARSE_RESULTS:
+ while (presult.size() > 0)
+ {
+ parseResult(presult.remove(0), presultTitle.remove(0), null,
+ preferredFeatureColours);
+ }
+ break;
+ case STATE_TASK_ERROR:
+ showProgress(null);
+ super.cancelAsync();
+ return 0; // arbitrary; ignored
}
- guiWindow.setProgressBar(MessageManager
- .getString("status.finshed_querying"), Thread.currentThread()
- .hashCode());
+ return STATE_DONE;
}
- guiWindow.setProgressBar(
- (presult.size() > 0) ? MessageManager
- .getString("status.parsing_results") : MessageManager
- .getString("status.processing"), Thread.currentThread()
- .hashCode());
- // process results
- while (presult.size() > 0)
+
+ protected void resume()
{
- parseResult(presult.remove(0), presultTitle.remove(0), null,
- preferredFeatureColours);
+ if (!isAsync)
+ {
+ return;
+ }
+ super.setPaused(false);
+ super.stateLoop();
}
- // only remove visual delay after we finished parsing.
- guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
- if (nextFetch.size() > 0)
+
+ private int runSubtask(Runnable subtask)
{
- StringBuffer sb = new StringBuffer();
- sb.append("Didn't retrieve the following "
- + (nextFetch.size() == 1 ? "query" : nextFetch.size()
- + " queries") + ": \n");
- int l = sb.length(), lr = 0;
- for (String s : nextFetch)
+
+ Runnable r = new Runnable()
{
- if (l != sb.length())
+
+ @Override
+ public void run()
{
- sb.append("; ");
+ try
+ {
+ subtask.run();
+ } catch (Throwable e)
+ {
+ taskError = e;
+ }
+ if (checkError(taskError))
+ {
+ setProgressAsync(STATE_TASK_ERROR);
+ }
+ else
+ {
+ taskError = null;
+ }
+ if (isAsync)
+ {
+ resume();
+ }
}
- if (lr - sb.length() > 40)
+ };
+
+ if (isAsync)
+ {
+ super.setPaused(true);
+ new Thread(r).start();
+ return 0; // arbitrary return -- ignored because we are paused.
+ }
+ r.run();
+ return super.getProgressAsync();
+ }
+
+ @Override
+ public void doneAsync()
+ {
+ showProgress(null);
+ if (fetchList.size() > 0)
+ {
+ StringBuffer sb = new StringBuffer();
+ sb.append("Didn't retrieve the following "
+ + (fetchList.size() == 1 ? "query"
+ : fetchList.size() + " queries")
+ + ": \n");
+ int l = sb.length(), lr = 0;
+ for (String s : fetchList)
{
- sb.append("\n");
+ if (l != sb.length())
+ {
+ sb.append("; ");
+ }
+ if (lr - sb.length() > 40)
+ {
+ sb.append("\n");
+ }
+ sb.append(s);
}
- sb.append(s);
+ showErrorMessage(sb.toString());
}
- showErrorMessage(sb.toString());
+ resetDialog();
}
- resetDialog();
+
+ /**
+ *
+ * @param e
+ * @return true if there was an error and we need to STOP
+ */
+ protected boolean checkError(Throwable e)
+ {
+ if (e == null)
+ {
+ return false;
+ }
+ String problem = "retrieving " + ids + " from "
+ + database.getSelectedItem();
+ if (e instanceof Exception)
+ {
+ showErrorMessage("Error " + problem);
+ System.err.println("Retrieval failed for source ='"
+ + database.getSelectedItem() + "' and query\n'"
+ + ids + "'\n");
+ }
+ else if (e instanceof OutOfMemoryError)
+ {
+ showErrorMessage("Out of Memory when " + problem
+ + "\nPlease see the Jalview FAQ for instructions for increasing the memory available to Jalview.\n");
+ // option here to return false and quit this, but that is not how
+ // original code works - BH
+ // return false;
+ }
+ else
+ {
+ showErrorMessage("Serious Error " + problem);
+ }
+ e.printStackTrace();
+ return true;
+ }
+
+ private void showProgress(String msg)
+ {
+ guiWindow.setProgressBar(msg, myID);
+ }
+
}
/**
@@ -821,11 +839,10 @@ public class SequenceFetcher extends JPanel implements Runnable
*/
void fetchMultipleAccessions(DbSourceProxy proxy,
Iterator accessions, List aresultq,
- List aresult, List nextFetch)
- throws Exception
+ List aresult, List nextFetch) throws Exception
{
StringBuilder multiacc = new StringBuilder();
- List tosend = new ArrayList();
+ List tosend = new ArrayList<>();
while (accessions.hasNext())
{
String nel = accessions.next();
@@ -871,48 +888,19 @@ public class SequenceFetcher extends JPanel implements Runnable
* a list of successful queries to add to
* @param aresult
* a list of retrieved alignments to add to
- * @return true if the fetch was successful, else false
+ * @return null if the fetch was successful; the accession if not
*/
- boolean fetchSingleAccession(DbSourceProxy proxy, String accession,
- List aresultq, List aresult)
+ String fetchSingleAccession(DbSourceProxy proxy, String accession,
+ List aresultq, List aresult) throws Throwable
{
- boolean success = false;
- try
- {
- if (aresult != null)
- {
- try
- {
- // give the server a chance to breathe
- Thread.sleep(5);
- } catch (Exception e)
- {
- //
- }
- }
-
- AlignmentI indres = null;
- try
- {
- indres = proxy.getSequenceRecords(accession);
- } catch (OutOfMemoryError oome)
- {
- new OOMWarning("fetching " + accession + " from "
- + proxy.getDbName(), oome, this);
- }
- if (indres != null)
- {
- aresultq.add(accession);
- aresult.add(indres);
- success = true;
- }
- } catch (Exception e)
+ AlignmentI indres = proxy.getSequenceRecords(accession);
+ if (indres == null)
{
- Cache.log.info(
- "Error retrieving " + accession
- + " from " + proxy.getDbName(), e);
+ return accession;
}
- return success;
+ aresultq.add(accession);
+ aresult.add(indres);
+ return null;
}
/**
@@ -932,13 +920,14 @@ public class SequenceFetcher extends JPanel implements Runnable
for (String q : queries)
{
- DBRefEntry dbr = new DBRefEntry();
- dbr.setSource(proxy.getDbSource());
- dbr.setVersion(null);
+ // BH 2019.01.25 dbr is never used.
+ // DBRefEntry dbr = new DBRefEntry();
+ // dbr.setSource(proxy.getDbSource());
+ // dbr.setVersion(null);
String accId = proxy.getAccessionIdFromQuery(q);
- dbr.setAccessionId(accId);
+ // dbr.setAccessionId(accId);
boolean rfound = false;
- for (int r = 0; r < rs.length; r++)
+ for (int r = 0, nr = rs.length; r < nr; r++)
{
if (rs[r] != null)
{
@@ -969,7 +958,7 @@ public class SequenceFetcher extends JPanel implements Runnable
}
AlignmentI parseResult(AlignmentI al, String title,
- String currentFileFormat,
+ FileFormatI currentFileFormat,
FeatureSettingsModelI preferredFeatureColours)
{
@@ -985,27 +974,19 @@ public class SequenceFetcher extends JPanel implements Runnable
AlignFrame.DEFAULT_HEIGHT);
if (currentFileFormat != null)
{
- af.currentFileFormat = currentFileFormat; // WHAT IS THE DEFAULT
- // FORMAT FOR
- // NON-FormatAdapter Sourced
- // Alignments?
+ af.currentFileFormat = currentFileFormat;
}
- SequenceFeature[] sfs = null;
- List alsqs;
- synchronized (alsqs = al.getSequences())
+ List alsqs = al.getSequences();
+ synchronized (alsqs)
{
for (SequenceI sq : alsqs)
{
- if ((sfs = sq.getSequenceFeatures()) != null)
+ if (sq.getFeatures().hasFeatures())
{
- if (sfs.length > 0)
- {
- af.setShowSeqFeatures(true);
- break;
- }
+ af.setShowSeqFeatures(true);
+ break;
}
-
}
}
@@ -1013,24 +994,20 @@ public class SequenceFetcher extends JPanel implements Runnable
{
af.getViewport().applyFeaturesStyle(preferredFeatureColours);
}
- if (Cache.getDefault("HIDE_INTRONS", true))
+ if (Cache.getDefault(Preferences.HIDE_INTRONS, true))
{
af.hideFeatureColumns(SequenceOntologyI.EXON, false);
}
- if (newAlframes != null)
- {
- newAlframes.add(af);
- }
Desktop.addInternalFrame(af, title, AlignFrame.DEFAULT_WIDTH,
AlignFrame.DEFAULT_HEIGHT);
- af.statusBar.setText(MessageManager
+ af.setStatus(MessageManager
.getString("label.successfully_pasted_alignment_file"));
try
{
- af.setMaximum(Cache.getDefault("SHOW_FULLSCREEN",
- false));
+ af.setMaximum(
+ Cache.getDefault(Preferences.SHOW_FULLSCREEN, false));
} catch (Exception ex)
{
}
@@ -1051,9 +1028,10 @@ public class SequenceFetcher extends JPanel implements Runnable
@Override
public void run()
{
- JOptionPane.showInternalMessageDialog(Desktop.desktop, error,
+ JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
+ error,
MessageManager.getString("label.error_retrieving_data"),
- JOptionPane.WARNING_MESSAGE);
+ JvOptionPane.WARNING_MESSAGE);
}
});
}
@@ -1069,20 +1047,27 @@ public class SequenceFetcher extends JPanel implements Runnable
}
/**
- * Make this panel visible (after a selection has been made in the database
+ * Hide this panel (on clicking the database button to open the database
* chooser)
*/
- void showPanel()
+ void hidePanel()
{
- frame.setVisible(true);
+ frame.setVisible(false);
}
/**
- * Hide this panel (on clicking the database button to open the database
- * chooser)
+ * Called to modify the search panel for embedding as an alternative tab of a
+ * free text search panel. The database choice list is hidden (since the
+ * choice has been made), and a Back button is made visible (which reopens the
+ * Sequence Fetcher panel).
+ *
+ * @param parentPanel
*/
- void hidePanel()
+ public void embedIn(GFTSPanel parentPanel)
{
- frame.setVisible(false);
+ database.setVisible(false);
+ backBtn.setVisible(true);
+ parentSearchPanel = parentPanel;
}
+
}