X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FStructureChooser.java;h=7a9da92716b54267b45bb93bafa5e95c4f228220;hb=bf5bc203579d7a291844f3b34d5e8431984ee8e2;hp=57debe394984c2a8a391670796ef555c84f14b9d;hpb=853624fb32058cccc544ae7d13af6ad4b0800b6c;p=jalview.git diff --git a/src/jalview/gui/StructureChooser.java b/src/jalview/gui/StructureChooser.java index 57debe3..7a9da92 100644 --- a/src/jalview/gui/StructureChooser.java +++ b/src/jalview/gui/StructureChooser.java @@ -21,6 +21,8 @@ package jalview.gui; +import jalview.api.structures.JalviewStructureDisplayI; +import jalview.bin.Cache; import jalview.bin.Jalview; import jalview.datamodel.DBRefEntry; import jalview.datamodel.DBRefSource; @@ -29,9 +31,14 @@ import jalview.datamodel.SequenceI; import jalview.fts.api.FTSData; import jalview.fts.api.FTSDataColumnI; import jalview.fts.api.FTSRestClientI; +import jalview.fts.core.FTSDataColumnPreferences; import jalview.fts.core.FTSRestRequest; import jalview.fts.core.FTSRestResponse; import jalview.fts.service.pdb.PDBFTSRestClient; +import jalview.gui.structurechooser.PDBStructureChooserQuerySource; +import jalview.gui.structurechooser.StructureChooserQuerySource; +import jalview.io.DataSourceType; +import jalview.jbgui.FilterOption; import jalview.jbgui.GStructureChooser; import jalview.structure.StructureMapping; import jalview.structure.StructureSelectionManager; @@ -52,7 +59,8 @@ import java.util.Vector; import javax.swing.JCheckBox; import javax.swing.JComboBox; import javax.swing.JLabel; -import javax.swing.JOptionPane; +import javax.swing.JTable; +import javax.swing.SwingUtilities; import javax.swing.table.AbstractTableModel; /** @@ -62,9 +70,11 @@ import javax.swing.table.AbstractTableModel; * */ @SuppressWarnings("serial") -public class StructureChooser extends GStructureChooser implements - IProgressIndicator +public class StructureChooser extends GStructureChooser + implements IProgressIndicator { + private static final String AUTOSUPERIMPOSE = "AUTOSUPERIMPOSE"; + private SequenceI selectedSequence; private SequenceI[] selectedSequences; @@ -73,36 +83,52 @@ public class StructureChooser extends GStructureChooser implements private Collection discoveredStructuresSet; - private FTSRestRequest lastPdbRequest; + private StructureChooserQuerySource data; - private FTSRestClientI pdbRestCleint; + @Override + protected FTSDataColumnPreferences getFTSDocFieldPrefs() + { + return data.getDocFieldPrefs(); + } private String selectedPdbFileName; private boolean isValidPBDEntry; + private boolean cachedPDBExists; + + private static StructureViewer lastTargetedView = null; + public StructureChooser(SequenceI[] selectedSeqs, SequenceI selectedSeq, AlignmentPanel ap) { + // which FTS engine to use + data = StructureChooserQuerySource + .getTDBfts(); + initDialog(); + this.ap = ap; this.selectedSequence = selectedSeq; this.selectedSequences = selectedSeqs; this.progressIndicator = (ap == null) ? null : ap.alignFrame; init(); + } /** * Initializes parameters used by the Structure Chooser Panel */ - public void init() + protected void init() { if (!Jalview.isHeadlessMode()) { progressBar = new ProgressBar(this.statusPanel, this.statusBar); } + chk_superpose.setSelected(Cache.getDefault(AUTOSUPERIMPOSE, true)); + // ensure a filter option is in force for search - populateFilterComboBox(true); + populateFilterComboBox(true, cachedPDBExists); Thread discoverPDBStructuresThread = new Thread(new Runnable() { @Override @@ -113,12 +139,12 @@ public class StructureChooser extends GStructureChooser implements .getString("status.loading_cached_pdb_entries"), startTime); loadLocalCachedPDBEntries(); updateProgressIndicator(null, startTime); - updateProgressIndicator(MessageManager - .getString("status.searching_for_pdb_structures"), - startTime); + updateProgressIndicator(MessageManager.getString( + "status.searching_for_pdb_structures"), startTime); fetchStructuresMetaData(); // revise filter options if no results were found - populateFilterComboBox(isStructuresDiscovered()); + populateFilterComboBox(isStructuresDiscovered(), cachedPDBExists); + discoverStructureViews(); updateProgressIndicator(null, startTime); mainFrame.setVisible(true); updateCurrentView(); @@ -128,6 +154,58 @@ public class StructureChooser extends GStructureChooser implements } /** + * Builds a drop-down choice list of existing structure viewers to which new + * structures may be added. If this list is empty then it, and the 'Add' + * button, are hidden. + */ + private void discoverStructureViews() + { + if (Desktop.instance != null) + { + targetView.removeAllItems(); + if (lastTargetedView != null && !lastTargetedView.isVisible()) + { + lastTargetedView = null; + } + int linkedViewsAt = 0; + for (StructureViewerBase view : Desktop.instance + .getStructureViewers(null, null)) + { + StructureViewer viewHandler = (lastTargetedView != null + && lastTargetedView.sview == view) ? lastTargetedView + : StructureViewer.reconfigure(view); + + if (view.isLinkedWith(ap)) + { + targetView.insertItemAt(viewHandler, linkedViewsAt++); + } + else + { + targetView.addItem(viewHandler); + } + } + + /* + * show option to Add to viewer if at least 1 viewer found + */ + targetView.setVisible(false); + if (targetView.getItemCount() > 0) + { + targetView.setVisible(true); + if (lastTargetedView != null) + { + targetView.setSelectedItem(lastTargetedView); + } + else + { + targetView.setSelectedIndex(0); + } + } + btn_add.setVisible(targetView.isVisible()); + } + } + + /** * Updates the progress indicator with the specified message * * @param message @@ -135,7 +213,7 @@ public class StructureChooser extends GStructureChooser implements * @param id * unique handle for this indicator */ - public void updateProgressIndicator(String message, long id) + protected void updateProgressIndicator(String message, long id) { if (progressIndicator != null) { @@ -147,39 +225,38 @@ public class StructureChooser extends GStructureChooser implements * Retrieve meta-data for all the structure(s) for a given sequence(s) in a * selection group */ - public void fetchStructuresMetaData() + void fetchStructuresMetaData() { long startTime = System.currentTimeMillis(); - pdbRestCleint = PDBFTSRestClient.getInstance(); - Collection wantedFields = pdbDocFieldPrefs + Collection wantedFields = data.getDocFieldPrefs() .getStructureSummaryFields(); - discoveredStructuresSet = new LinkedHashSet(); - HashSet errors = new HashSet(); + discoveredStructuresSet = new LinkedHashSet<>(); + HashSet errors = new HashSet<>(); + + FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption + .getSelectedItem()); + for (SequenceI seq : selectedSequences) { - FTSRestRequest pdbRequest = new FTSRestRequest(); - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(500); - pdbRequest.setFieldToSearchBy("("); - FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption - .getSelectedItem()); - pdbRequest.setFieldToSortBy(selectedFilterOpt.getValue(), - !chk_invertFilter.isSelected()); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setSearchTerm(buildQuery(seq) + ")"); - pdbRequest.setAssociatedSequence(seq); + FTSRestResponse resultList; try { - resultList = pdbRestCleint.executeRequest(pdbRequest); + resultList = data.fetchStructuresMetaData(seq, wantedFields, + selectedFilterOpt, !chk_invertFilter.isSelected()); + // null response means the FTSengine didn't yield a query for this + // consider designing a special exception if we really wanted to be OOCrazy + if (resultList==null) + { + continue; + } } catch (Exception e) { e.printStackTrace(); errors.add(e.getMessage()); continue; } - lastPdbRequest = pdbRequest; if (resultList.getSearchSummary() != null && !resultList.getSearchSummary().isEmpty()) { @@ -193,9 +270,8 @@ public class StructureChooser extends GStructureChooser implements if (discoveredStructuresSet != null && !discoveredStructuresSet.isEmpty()) { - getResultTable().setModel( - FTSRestResponse.getTableModel(lastPdbRequest, - discoveredStructuresSet)); + getResultTable() + .setModel(data.getTableModel(discoveredStructuresSet)); noOfStructuresFound = discoveredStructuresSet.size(); mainFrame.setTitle(MessageManager.formatMessage( "label.structure_chooser_no_of_structures", @@ -212,16 +288,16 @@ public class StructureChooser extends GStructureChooser implements { errorMsg.append(error).append("\n"); } - JOptionPane.showMessageDialog(this, errorMsg.toString(), + JvOptionPane.showMessageDialog(this, errorMsg.toString(), MessageManager.getString("label.pdb_web-service_error"), - JOptionPane.ERROR_MESSAGE); + JvOptionPane.ERROR_MESSAGE); } } } - public void loadLocalCachedPDBEntries() + protected void loadLocalCachedPDBEntries() { - ArrayList entries = new ArrayList(); + ArrayList entries = new ArrayList<>(); for (SequenceI seq : selectedSequences) { if (seq.getDatasetSequence() != null @@ -237,156 +313,18 @@ public class StructureChooser extends GStructureChooser implements } } } - + cachedPDBExists = !entries.isEmpty(); PDBEntryTableModel tableModelx = new PDBEntryTableModel(entries); tbl_local_pdb.setModel(tableModelx); } /** - * Builds a query string for a given sequences using its DBRef entries - * - * @param seq - * the sequences to build a query for - * @return the built query string - */ - - public static String buildQuery(SequenceI seq) - { - boolean isPDBRefsFound = false; - boolean isUniProtRefsFound = false; - StringBuilder queryBuilder = new StringBuilder(); - Set seqRefs = new LinkedHashSet(); - - if (seq.getAllPDBEntries() != null) - { - for (PDBEntry entry : seq.getAllPDBEntries()) - { - if (isValidSeqName(entry.getId())) - { - queryBuilder.append("pdb_id:") - .append(entry.getId().toLowerCase()).append(" OR "); - isPDBRefsFound = true; - // seqRefs.add(entry.getId()); - } - } - } - - if (seq.getDBRefs() != null && seq.getDBRefs().length != 0) - { - for (DBRefEntry dbRef : seq.getDBRefs()) - { - if (isValidSeqName(getDBRefId(dbRef))) - { - if (dbRef.getSource().equalsIgnoreCase(DBRefSource.UNIPROT)) - { - queryBuilder.append("uniprot_accession:") - .append(getDBRefId(dbRef)).append(" OR "); - queryBuilder.append("uniprot_id:").append(getDBRefId(dbRef)) - .append(" OR "); - isUniProtRefsFound = true; - } - else if (dbRef.getSource().equalsIgnoreCase(DBRefSource.PDB)) - { - - queryBuilder.append("pdb_id:") - .append(getDBRefId(dbRef).toLowerCase()).append(" OR "); - isPDBRefsFound = true; - } - else - { - seqRefs.add(getDBRefId(dbRef)); - } - } - } - } - - if (!isPDBRefsFound && !isUniProtRefsFound) - { - String seqName = seq.getName(); - seqName = sanitizeSeqName(seqName); - String[] names = seqName.toLowerCase().split("\\|"); - for (String name : names) - { - // System.out.println("Found name : " + name); - name.trim(); - if (isValidSeqName(name)) - { - seqRefs.add(name); - } - } - - for (String seqRef : seqRefs) - { - queryBuilder.append("text:").append(seqRef).append(" OR "); - } - } - - int endIndex = queryBuilder.lastIndexOf(" OR "); - if (queryBuilder.toString().length() < 6) - { - return null; - } - String query = queryBuilder.toString().substring(0, endIndex); - return query; - } - - /** - * Remove the following special characters from input string +, -, &, !, (, ), - * {, }, [, ], ^, ", ~, *, ?, :, \ - * - * @param seqName - * @return - */ - static String sanitizeSeqName(String seqName) - { - Objects.requireNonNull(seqName); - return seqName.replaceAll("\\[\\d*\\]", "") - .replaceAll("[^\\dA-Za-z|_]", "").replaceAll("\\s+", "+"); - } - - /** - * Ensures sequence ref names are not less than 3 characters and does not - * contain a database name - * - * @param seqName - * @return - */ - public static boolean isValidSeqName(String seqName) - { - // System.out.println("seqName : " + seqName); - String ignoreList = "pdb,uniprot,swiss-prot"; - if (seqName.length() < 3) - { - return false; - } - if (seqName.contains(":")) - { - return false; - } - seqName = seqName.toLowerCase(); - for (String ignoredEntry : ignoreList.split(",")) - { - if (seqName.contains(ignoredEntry)) - { - return false; - } - } - return true; - } - - public static String getDBRefId(DBRefEntry dbRef) - { - String ref = dbRef.getAccessionId().replaceAll("GO:", ""); - return ref; - } - - /** * Filters a given list of discovered structures based on supplied argument * * @param fieldToFilterBy * the field to filter by */ - public void filterResultSet(final String fieldToFilterBy) + void filterResultSet(final String fieldToFilterBy) { Thread filterThread = new Thread(new Runnable() { @@ -394,50 +332,27 @@ public class StructureChooser extends GStructureChooser implements public void run() { long startTime = System.currentTimeMillis(); - pdbRestCleint = PDBFTSRestClient.getInstance(); lbl_loading.setVisible(true); - Collection wantedFields = pdbDocFieldPrefs + Collection wantedFields = data.getDocFieldPrefs() .getStructureSummaryFields(); - Collection filteredResponse = new HashSet(); - HashSet errors = new HashSet(); + Collection filteredResponse = new HashSet<>(); + HashSet errors = new HashSet<>(); for (SequenceI seq : selectedSequences) { - FTSRestRequest pdbRequest = new FTSRestRequest(); - if (fieldToFilterBy.equalsIgnoreCase("uniprot_coverage")) - { - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(1); - pdbRequest.setFieldToSearchBy("("); - pdbRequest.setSearchTerm(buildQuery(seq) + ")"); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setAssociatedSequence(seq); - pdbRequest.setFacet(true); - pdbRequest.setFacetPivot(fieldToFilterBy + ",entry_entity"); - pdbRequest.setFacetPivotMinCount(1); - } - else - { - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(1); - pdbRequest.setFieldToSearchBy("("); - pdbRequest.setFieldToSortBy(fieldToFilterBy, - !chk_invertFilter.isSelected()); - pdbRequest.setSearchTerm(buildQuery(seq) + ")"); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setAssociatedSequence(seq); - } + FTSRestResponse resultList; try { - resultList = pdbRestCleint.executeRequest(pdbRequest); + resultList = data.selectFirstRankedQuery(seq, wantedFields, + fieldToFilterBy, !chk_invertFilter.isSelected()); + } catch (Exception e) { e.printStackTrace(); errors.add(e.getMessage()); continue; } - lastPdbRequest = pdbRequest; if (resultList.getSearchSummary() != null && !resultList.getSearchSummary().isEmpty()) { @@ -450,12 +365,11 @@ public class StructureChooser extends GStructureChooser implements if (!filteredResponse.isEmpty()) { final int filterResponseCount = filteredResponse.size(); - Collection reorderedStructuresSet = new LinkedHashSet(); + Collection reorderedStructuresSet = new LinkedHashSet<>(); reorderedStructuresSet.addAll(filteredResponse); reorderedStructuresSet.addAll(discoveredStructuresSet); - getResultTable().setModel( - FTSRestResponse.getTableModel(lastPdbRequest, - reorderedStructuresSet)); + getResultTable() + .setModel(data.getTableModel(reorderedStructuresSet)); FTSRestResponse.configureTableColumn(getResultTable(), wantedFields, tempUserPrefs); @@ -479,11 +393,9 @@ public class StructureChooser extends GStructureChooser implements { errorMsg.append(error).append("\n"); } - JOptionPane.showMessageDialog( - null, - errorMsg.toString(), + JvOptionPane.showMessageDialog(null, errorMsg.toString(), MessageManager.getString("label.pdb_web-service_error"), - JOptionPane.ERROR_MESSAGE); + JvOptionPane.ERROR_MESSAGE); } } @@ -499,14 +411,17 @@ public class StructureChooser extends GStructureChooser implements * Handles action event for btn_pdbFromFile */ @Override - public void pdbFromFile_actionPerformed() + protected void pdbFromFile_actionPerformed() { + // TODO: JAL-3048 not needed for Jalview-JS until JSmol dep and + // StructureChooser + // works jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser( jalview.bin.Cache.getProperty("LAST_DIRECTORY")); chooser.setFileView(new jalview.io.JalviewFileView()); - chooser.setDialogTitle(MessageManager.formatMessage( - "label.select_pdb_file_for", - selectedSequence.getDisplayId(false))); + chooser.setDialogTitle( + MessageManager.formatMessage("label.select_pdb_file_for", + selectedSequence.getDisplayId(false))); chooser.setToolTipText(MessageManager.formatMessage( "label.load_pdb_file_associate_with_sequence", selectedSequence.getDisplayId(false))); @@ -524,7 +439,8 @@ public class StructureChooser extends GStructureChooser implements * Populates the filter combo-box options dynamically depending on discovered * structures */ - protected void populateFilterComboBox(boolean haveData) + protected void populateFilterComboBox(boolean haveData, + boolean cachedPDBExist) { /* * temporarily suspend the change listener behaviour @@ -534,23 +450,27 @@ public class StructureChooser extends GStructureChooser implements cmb_filterOption.removeAllItems(); if (haveData) { - cmb_filterOption.addItem(new FilterOption("Best Quality", - "overall_quality", VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Best Resolution", - "resolution", VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Protein Chain", - "number_of_protein_chains", VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Bound Molecules", - "number_of_bound_molecules", VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Polymer Residues", - "number_of_polymer_residues", VIEWS_FILTER)); + List filters = data.getAvailableFilterOptions(VIEWS_FILTER); + for (FilterOption filter:filters) + { + cmb_filterOption.addItem(filter); + } + } + cmb_filterOption.addItem( + new FilterOption(MessageManager.getString("label.enter_pdb_id"), + "-", VIEWS_ENTER_ID, false)); + cmb_filterOption.addItem( + new FilterOption(MessageManager.getString("label.from_file"), + "-", VIEWS_FROM_FILE, false)); + + if (cachedPDBExist) + { + FilterOption cachedOption = new FilterOption( + MessageManager.getString("label.cached_structures"), "-", + VIEWS_LOCAL_PDB, false); + cmb_filterOption.addItem(cachedOption); + cmb_filterOption.setSelectedItem(cachedOption); } - cmb_filterOption.addItem(new FilterOption("Enter PDB Id", "-", - VIEWS_ENTER_ID)); - cmb_filterOption.addItem(new FilterOption("From File", "-", - VIEWS_FROM_FILE)); - cmb_filterOption.addItem(new FilterOption("Cached PDB Entries", "-", - VIEWS_LOCAL_PDB)); cmb_filterOption.addItemListener(this); } @@ -585,28 +505,37 @@ public class StructureChooser extends GStructureChooser implements } /** - * Validates user selection and activates the view button if all parameters - * are correct + * Validates user selection and enables the 'Add' and 'New View' buttons if + * all parameters are correct (the Add button will only be visible if there is + * at least one existing structure viewer open). This basically means at least + * one structure selected and no error messages. + *

+ * The 'Superpose Structures' option is enabled if either more than one + * structure is selected, or the 'Add' to existing view option is enabled, and + * disabled if the only option is to open a new view of a single structure. */ @Override - public void validateSelections() + protected void validateSelections() { FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption .getSelectedItem()); - btn_view.setEnabled(false); + btn_add.setEnabled(false); String currentView = selectedFilterOpt.getView(); + int selectedCount = 0; if (currentView == VIEWS_FILTER) { - if (getResultTable().getSelectedRows().length > 0) + selectedCount = getResultTable().getSelectedRows().length; + if (selectedCount > 0) { - btn_view.setEnabled(true); + btn_add.setEnabled(true); } } else if (currentView == VIEWS_LOCAL_PDB) { - if (tbl_local_pdb.getSelectedRows().length > 0) + selectedCount = tbl_local_pdb.getSelectedRows().length; + if (selectedCount > 0) { - btn_view.setEnabled(true); + btn_add.setEnabled(true); } } else if (currentView == VIEWS_ENTER_ID) @@ -617,12 +546,21 @@ public class StructureChooser extends GStructureChooser implements { validateAssociationFromFile(); } + + btn_newView.setEnabled(btn_add.isEnabled()); + + /* + * enable 'Superpose' option if more than one structure is selected, + * or there are view(s) available to add structure(s) to + */ + chk_superpose + .setEnabled(selectedCount > 1 || targetView.getItemCount() > 0); } /** * Validates inputs from the Manual PDB entry panel */ - public void validateAssociationEnterPdb() + protected void validateAssociationEnterPdb() { AssociateSeqOptions assSeqOpt = (AssociateSeqOptions) idInputAssSeqPanel .getCmb_assSeq().getSelectedItem(); @@ -630,27 +568,25 @@ public class StructureChooser extends GStructureChooser implements lbl_pdbManualFetchStatus.setToolTipText(""); if (txt_search.getText().length() > 0) { - lbl_pdbManualFetchStatus - .setToolTipText(JvSwingUtils.wrapTooltip(true, MessageManager - .formatMessage("info.no_pdb_entry_found_for", - txt_search.getText()))); + lbl_pdbManualFetchStatus.setToolTipText(JvSwingUtils.wrapTooltip(true, + MessageManager.formatMessage("info.no_pdb_entry_found_for", + txt_search.getText()))); } if (errorWarning.length() > 0) { lbl_pdbManualFetchStatus.setIcon(warningImage); - lbl_pdbManualFetchStatus.setToolTipText(JvSwingUtils.wrapTooltip( - true, errorWarning.toString())); + lbl_pdbManualFetchStatus.setToolTipText( + JvSwingUtils.wrapTooltip(true, errorWarning.toString())); } - if (selectedSequences.length == 1 - || !assSeqOpt.getName().equalsIgnoreCase( - "-Select Associated Seq-")) + if (selectedSequences.length == 1 || !assSeqOpt.getName() + .equalsIgnoreCase("-Select Associated Seq-")) { txt_search.setEnabled(true); if (isValidPBDEntry) { - btn_view.setEnabled(true); + btn_add.setEnabled(true); lbl_pdbManualFetchStatus.setToolTipText(""); lbl_pdbManualFetchStatus.setIcon(goodImage); } @@ -665,19 +601,18 @@ public class StructureChooser extends GStructureChooser implements /** * Validates inputs for the manual PDB file selection options */ - public void validateAssociationFromFile() + protected void validateAssociationFromFile() { AssociateSeqOptions assSeqOpt = (AssociateSeqOptions) fileChooserAssSeqPanel .getCmb_assSeq().getSelectedItem(); lbl_fromFileStatus.setIcon(errorImage); - if (selectedSequences.length == 1 - || (assSeqOpt != null && !assSeqOpt.getName().equalsIgnoreCase( - "-Select Associated Seq-"))) + if (selectedSequences.length == 1 || (assSeqOpt != null && !assSeqOpt + .getName().equalsIgnoreCase("-Select Associated Seq-"))) { btn_pdbFromFile.setEnabled(true); if (selectedPdbFileName != null && selectedPdbFileName.length() > 0) { - btn_view.setEnabled(true); + btn_add.setEnabled(true); lbl_fromFileStatus.setIcon(goodImage); } } @@ -689,7 +624,7 @@ public class StructureChooser extends GStructureChooser implements } @Override - public void cmbAssSeqStateChanged() + protected void cmbAssSeqStateChanged() { validateSelections(); } @@ -716,17 +651,76 @@ public class StructureChooser extends GStructureChooser implements } /** - * Handles action event for btn_ok + * select structures for viewing by their PDB IDs + * + * @param pdbids + * @return true if structures were found and marked as selected + */ + public boolean selectStructure(String... pdbids) + { + boolean found = false; + + FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption + .getSelectedItem()); + String currentView = selectedFilterOpt.getView(); + JTable restable = (currentView == VIEWS_FILTER) ? getResultTable() + : (currentView == VIEWS_LOCAL_PDB) ? tbl_local_pdb : null; + + if (restable == null) + { + // can't select (enter PDB ID, or load file - need to also select which + // sequence to associate with) + return false; + } + + int pdbIdColIndex = restable.getColumn("PDB Id").getModelIndex(); + for (int r = 0; r < restable.getRowCount(); r++) + { + for (int p = 0; p < pdbids.length; p++) + { + if (String.valueOf(restable.getValueAt(r, pdbIdColIndex)) + .equalsIgnoreCase(pdbids[p])) + { + restable.setRowSelectionInterval(r, r); + found = true; + } + } + } + return found; + } + + /** + * Handles the 'New View' action */ @Override - public void ok_ActionPerformed() + protected void newView_ActionPerformed() { - final long progressSessionId = System.currentTimeMillis(); + targetView.setSelectedItem(null); + showStructures(false); + } + + /** + * Handles the 'Add to existing viewer' action + */ + @Override + protected void add_ActionPerformed() + { + showStructures(false); + } + + /** + * structure viewer opened by this dialog, or null + */ + private StructureViewer sViewer = null; + + public void showStructures(boolean waitUntilFinished) + { + final StructureSelectionManager ssm = ap.getStructureSelectionManager(); + final int preferredHeight = pnl_filter.getHeight(); - ssm.setProgressIndicator(this); - ssm.setProgressSessionId(progressSessionId); - new Thread(new Runnable() + + Runnable viewStruc = new Runnable() { @Override public void run() @@ -734,41 +728,20 @@ public class StructureChooser extends GStructureChooser implements FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption .getSelectedItem()); String currentView = selectedFilterOpt.getView(); + JTable restable = (currentView == VIEWS_FILTER) ? getResultTable() + : tbl_local_pdb; + if (currentView == VIEWS_FILTER) { - int pdbIdColIndex = getResultTable().getColumn("PDB Id") - .getModelIndex(); - int refSeqColIndex = getResultTable().getColumn("Ref Sequence") - .getModelIndex(); - int[] selectedRows = getResultTable().getSelectedRows(); + int[] selectedRows = restable.getSelectedRows(); PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length]; - int count = 0; - ArrayList selectedSeqsToView = new ArrayList(); - for (int row : selectedRows) - { - String pdbIdStr = getResultTable().getValueAt(row, - pdbIdColIndex).toString(); - SequenceI selectedSeq = (SequenceI) getResultTable() - .getValueAt(row, refSeqColIndex); - selectedSeqsToView.add(selectedSeq); - PDBEntry pdbEntry = selectedSeq.getPDBEntry(pdbIdStr); - if (pdbEntry == null) - { - pdbEntry = getFindEntry(pdbIdStr, - selectedSeq.getAllPDBEntries()); - } - if (pdbEntry == null) - { - pdbEntry = new PDBEntry(); - pdbEntry.setId(pdbIdStr); - pdbEntry.setType(PDBEntry.Type.PDB); - selectedSeq.getDatasetSequence().addPDBId(pdbEntry); - } - pdbEntriesToView[count++] = pdbEntry; - } + List selectedSeqsToView = new ArrayList<>(); + pdbEntriesToView = data.collectSelectedRows(restable,selectedRows,selectedSeqsToView); + SequenceI[] selectedSeqs = selectedSeqsToView .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + selectedSeqs); } else if (currentView == VIEWS_LOCAL_PDB) { @@ -779,19 +752,20 @@ public class StructureChooser extends GStructureChooser implements .getModelIndex(); int refSeqColIndex = tbl_local_pdb.getColumn("Ref Sequence") .getModelIndex(); - ArrayList selectedSeqsToView = new ArrayList(); + List selectedSeqsToView = new ArrayList<>(); for (int row : selectedRows) { PDBEntry pdbEntry = (PDBEntry) tbl_local_pdb.getValueAt(row, pdbIdColIndex); pdbEntriesToView[count++] = pdbEntry; - SequenceI selectedSeq = (SequenceI) tbl_local_pdb.getValueAt( - row, refSeqColIndex); + SequenceI selectedSeq = (SequenceI) tbl_local_pdb + .getValueAt(row, refSeqColIndex); selectedSeqsToView.add(selectedSeq); } SequenceI[] selectedSeqs = selectedSeqsToView .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + selectedSeqs); } else if (currentView == VIEWS_ENTER_ID) { @@ -801,7 +775,6 @@ public class StructureChooser extends GStructureChooser implements { selectedSequence = userSelectedSeq; } - String pdbIdStr = txt_search.getText(); PDBEntry pdbEntry = selectedSequence.getPDBEntry(pdbIdStr); if (pdbEntry == null) @@ -821,8 +794,9 @@ public class StructureChooser extends GStructureChooser implements } PDBEntry[] pdbEntriesToView = new PDBEntry[] { pdbEntry }; - launchStructureViewer(ssm, pdbEntriesToView, ap, - new SequenceI[] { selectedSequence }); + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + new SequenceI[] + { selectedSequence }); } else if (currentView == VIEWS_FROM_FILE) { @@ -834,43 +808,87 @@ public class StructureChooser extends GStructureChooser implements } PDBEntry fileEntry = new AssociatePdbFileWithSeq() .associatePdbWithSeq(selectedPdbFileName, - jalview.io.AppletFormatAdapter.FILE, - selectedSequence, true, Desktop.instance); + DataSourceType.FILE, selectedSequence, true, + Desktop.instance); - launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, - new SequenceI[] { selectedSequence }); + sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, + ap, new SequenceI[] + { selectedSequence }); } - closeAction(preferredHeight); + SwingUtilities.invokeLater(new Runnable() + { + @Override + public void run() + { + closeAction(preferredHeight); + mainFrame.dispose(); + } + }); } - }).start(); - } - - private PDBEntry getFindEntry(String id, Vector pdbEntries) - { - Objects.requireNonNull(id); - Objects.requireNonNull(pdbEntries); - PDBEntry foundEntry = null; - for (PDBEntry entry : pdbEntries) + }; + Thread runner = new Thread(viewStruc); + runner.start(); + if (waitUntilFinished) { - if (entry.getId().equalsIgnoreCase(id)) + while (sViewer == null ? runner.isAlive() + : (sViewer.sview == null ? true + : !sViewer.sview.hasMapping())) { - return entry; + try + { + Thread.sleep(300); + } catch (InterruptedException ie) + { + + } } } - return foundEntry; } - private void launchStructureViewer(StructureSelectionManager ssm, - final PDBEntry[] pdbEntriesToView, + /** + * Answers a structure viewer (new or existing) configured to superimpose + * added structures or not according to the user's choice + * + * @param ssm + * @return + */ + StructureViewer getTargetedStructureViewer(StructureSelectionManager ssm) + { + Object sv = targetView.getSelectedItem(); + + return sv == null ? new StructureViewer(ssm) : (StructureViewer) sv; + } + + /** + * Adds PDB structures to a new or existing structure viewer + * + * @param ssm + * @param pdbEntriesToView + * @param alignPanel + * @param sequences + * @return + */ + private StructureViewer launchStructureViewer( + StructureSelectionManager ssm, final PDBEntry[] pdbEntriesToView, final AlignmentPanel alignPanel, SequenceI[] sequences) { - ssm.setProgressBar(MessageManager - .getString("status.launching_3d_structure_viewer")); - final StructureViewer sViewer = new StructureViewer(ssm); + long progressId = sequences.hashCode(); + setProgressBar(MessageManager + .getString("status.launching_3d_structure_viewer"), progressId); + final StructureViewer theViewer = getTargetedStructureViewer(ssm); + boolean superimpose = chk_superpose.isSelected(); + theViewer.setSuperpose(superimpose); + + /* + * remember user's choice of superimpose or not + */ + Cache.setProperty(AUTOSUPERIMPOSE, + Boolean.valueOf(superimpose).toString()); + setProgressBar(null, progressId); if (SiftsSettings.isMapWithSifts()) { - List seqsWithoutSourceDBRef = new ArrayList(); + List seqsWithoutSourceDBRef = new ArrayList<>(); int p = 0; // TODO: skip PDBEntry:Sequence pairs where PDBEntry doesn't look like a // real PDB ID. For moment, we can also safely do this if there is already @@ -892,7 +910,7 @@ public class StructureChooser extends GStructureChooser implements } } } - if (seq.getPrimaryDBRefs().size() == 0) + if (seq.getPrimaryDBRefs().isEmpty()) { seqsWithoutSourceDBRef.add(seq); continue; @@ -901,41 +919,36 @@ public class StructureChooser extends GStructureChooser implements if (!seqsWithoutSourceDBRef.isEmpty()) { int y = seqsWithoutSourceDBRef.size(); - ssm.setProgressBar(null); - ssm.setProgressBar(MessageManager.formatMessage( + setProgressBar(MessageManager.formatMessage( "status.fetching_dbrefs_for_sequences_without_valid_refs", - y)); - SequenceI[] seqWithoutSrcDBRef = new SequenceI[y]; - int x = 0; - for (SequenceI fSeq : seqsWithoutSourceDBRef) - { - seqWithoutSrcDBRef[x++] = fSeq; - } + y), progressId); + SequenceI[] seqWithoutSrcDBRef = seqsWithoutSourceDBRef + .toArray(new SequenceI[y]); DBRefFetcher dbRefFetcher = new DBRefFetcher(seqWithoutSrcDBRef); dbRefFetcher.fetchDBRefs(true); + + setProgressBar("Fetch complete.", progressId); // todo i18n } } if (pdbEntriesToView.length > 1) { - ArrayList seqsMap = new ArrayList(); - for (SequenceI seq : sequences) - { - seqsMap.add(new SequenceI[] { seq }); - } - SequenceI[][] collatedSeqs = seqsMap.toArray(new SequenceI[0][0]); - ssm.setProgressBar(null); - ssm.setProgressBar(MessageManager - .getString("status.fetching_3d_structures_for_selected_entries")); - sViewer.viewStructures(pdbEntriesToView, collatedSeqs, alignPanel); + setProgressBar( + MessageManager.getString( + "status.fetching_3d_structures_for_selected_entries"), + progressId); + theViewer.viewStructures(pdbEntriesToView, sequences, alignPanel); } else { - ssm.setProgressBar(null); - ssm.setProgressBar(MessageManager.formatMessage( + setProgressBar(MessageManager.formatMessage( "status.fetching_3d_structures_for", - pdbEntriesToView[0].getId())); - sViewer.viewStructures(pdbEntriesToView[0], sequences, alignPanel); + pdbEntriesToView[0].getId()), progressId); + theViewer.viewStructures(pdbEntriesToView[0], sequences, alignPanel); } + setProgressBar(null, progressId); + // remember the last viewer we used... + lastTargetedView = theViewer; + return theViewer; } /** @@ -943,12 +956,13 @@ public class StructureChooser extends GStructureChooser implements * a unique sequence when more than one sequence selection is made. */ @Override - public void populateCmbAssociateSeqOptions( - JComboBox cmb_assSeq, JLabel lbl_associateSeq) + protected void populateCmbAssociateSeqOptions( + JComboBox cmb_assSeq, + JLabel lbl_associateSeq) { cmb_assSeq.removeAllItems(); - cmb_assSeq.addItem(new AssociateSeqOptions("-Select Associated Seq-", - null)); + cmb_assSeq.addItem( + new AssociateSeqOptions("-Select Associated Seq-", null)); lbl_associateSeq.setVisible(false); if (selectedSequences.length > 1) { @@ -967,67 +981,73 @@ public class StructureChooser extends GStructureChooser implements } } - public boolean isStructuresDiscovered() + protected boolean isStructuresDiscovered() { return discoveredStructuresSet != null && !discoveredStructuresSet.isEmpty(); } - public Collection getDiscoveredStructuresSet() - { - return discoveredStructuresSet; - } + protected int PDB_ID_MIN = 3;// or: (Jalview.isJS() ? 3 : 1); // Bob proposes + // this. + // Doing a search for "1" or "1c" is valuable? + // Those work but are enormously slow. @Override protected void txt_search_ActionPerformed() { - new Thread() - { - @Override - public void run() + String text = txt_search.getText().trim(); + if (text.length() >= PDB_ID_MIN) + new Thread() { - errorWarning.setLength(0); - isValidPBDEntry = false; - if (txt_search.getText().length() > 0) + + @Override + public void run() { - String searchTerm = txt_search.getText().toLowerCase(); - searchTerm = searchTerm.split(":")[0]; - // System.out.println(">>>>> search term : " + searchTerm); - List wantedFields = new ArrayList(); - FTSRestRequest pdbRequest = new FTSRestRequest(); - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(1); - pdbRequest.setFieldToSearchBy("(pdb_id:"); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setSearchTerm(searchTerm + ")"); - pdbRequest.setAssociatedSequence(selectedSequence); - pdbRestCleint = PDBFTSRestClient.getInstance(); - wantedFields.add(pdbRestCleint.getPrimaryKeyColumn()); - FTSRestResponse resultList; - try - { - resultList = pdbRestCleint.executeRequest(pdbRequest); - } catch (Exception e) - { - errorWarning.append(e.getMessage()); - return; - } finally - { - validateSelections(); - } - if (resultList.getSearchSummary() != null - && resultList.getSearchSummary().size() > 0) + errorWarning.setLength(0); + isValidPBDEntry = false; + if (text.length() > 0) { - isValidPBDEntry = true; + // TODO move this pdb id search into the PDB specific + // FTSSearchEngine + // for moment, it will work fine as is because it is self-contained + String searchTerm = text.toLowerCase(); + searchTerm = searchTerm.split(":")[0]; + // System.out.println(">>>>> search term : " + searchTerm); + List wantedFields = new ArrayList<>(); + FTSRestRequest pdbRequest = new FTSRestRequest(); + pdbRequest.setAllowEmptySeq(false); + pdbRequest.setResponseSize(1); + pdbRequest.setFieldToSearchBy("(pdb_id:"); + pdbRequest.setWantedFields(wantedFields); + pdbRequest.setSearchTerm(searchTerm + ")"); + pdbRequest.setAssociatedSequence(selectedSequence); + FTSRestClientI pdbRestClient = PDBFTSRestClient.getInstance(); + wantedFields.add(pdbRestClient.getPrimaryKeyColumn()); + FTSRestResponse resultList; + try + { + resultList = pdbRestClient.executeRequest(pdbRequest); + } catch (Exception e) + { + errorWarning.append(e.getMessage()); + return; + } finally + { + validateSelections(); + } + if (resultList.getSearchSummary() != null + && resultList.getSearchSummary().size() > 0) + { + isValidPBDEntry = true; + } } + validateSelections(); } - validateSelections(); - } - }.start(); + }.start(); } @Override - public void tabRefresh() + protected void tabRefresh() { if (selectedSequences != null) { @@ -1037,8 +1057,9 @@ public class StructureChooser extends GStructureChooser implements public void run() { fetchStructuresMetaData(); - filterResultSet(((FilterOption) cmb_filterOption - .getSelectedItem()).getValue()); + filterResultSet( + ((FilterOption) cmb_filterOption.getSelectedItem()) + .getValue()); } }); refreshThread.start(); @@ -1047,13 +1068,14 @@ public class StructureChooser extends GStructureChooser implements public class PDBEntryTableModel extends AbstractTableModel { - String[] columns = { "Ref Sequence", "PDB Id", "Chain", "Type", "File" }; + String[] columns = { "Ref Sequence", "PDB Id", "Chain", "Type", + "File" }; private List pdbEntries; public PDBEntryTableModel(List pdbEntries) { - this.pdbEntries = new ArrayList(pdbEntries); + this.pdbEntries = new ArrayList<>(pdbEntries); } @Override @@ -1094,8 +1116,8 @@ public class StructureChooser extends GStructureChooser implements value = entry.getPdbEntry(); break; case 2: - value = entry.getPdbEntry().getChainCode() == null ? "_" : entry - .getPdbEntry().getChainCode(); + value = entry.getPdbEntry().getChainCode() == null ? "_" + : entry.getPdbEntry().getChainCode(); break; case 3: value = entry.getPdbEntry().getType(); @@ -1163,4 +1185,16 @@ public class StructureChooser extends GStructureChooser implements { return progressBar.operationInProgress(); } + + public JalviewStructureDisplayI getOpenedStructureViewer() + { + return sViewer == null ? null : sViewer.sview; + } + + @Override + protected void setFTSDocFieldPrefs(FTSDataColumnPreferences newPrefs) + { + data.setDocFieldPrefs(newPrefs); + + } }