X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FStructureChooser.java;h=23b7fcf1ca9392937e2dba73f57d11cba22b2f48;hb=26b115b0a77d521da92a06572d9b7819c2d0d49a;hp=5d381b9bf84f1aaa0d10d8fc461ad95a25810212;hpb=782d4f5f28a6d138378b74ce74f4dbf14a49333f;p=jalview.git diff --git a/src/jalview/gui/StructureChooser.java b/src/jalview/gui/StructureChooser.java index 5d381b9..23b7fcf 100644 --- a/src/jalview/gui/StructureChooser.java +++ b/src/jalview/gui/StructureChooser.java @@ -21,21 +21,26 @@ package jalview.gui; +import jalview.api.structures.JalviewStructureDisplayI; +import jalview.bin.Cache; import jalview.bin.Jalview; import jalview.datamodel.DBRefEntry; import jalview.datamodel.DBRefSource; import jalview.datamodel.PDBEntry; import jalview.datamodel.SequenceI; +import jalview.fts.api.FTSData; +import jalview.fts.api.FTSDataColumnI; +import jalview.fts.api.FTSRestClientI; +import jalview.fts.core.FTSRestRequest; +import jalview.fts.core.FTSRestResponse; +import jalview.fts.service.pdb.PDBFTSRestClient; +import jalview.io.DataSourceType; import jalview.jbgui.GStructureChooser; -import jalview.jbgui.PDBDocFieldPreferences; +import jalview.structure.StructureMapping; import jalview.structure.StructureSelectionManager; import jalview.util.MessageManager; -import jalview.ws.dbsources.PDBRestClient; -import jalview.ws.dbsources.PDBRestClient.PDBDocField; +import jalview.ws.DBRefFetcher; import jalview.ws.sifts.SiftsSettings; -import jalview.ws.uimodel.PDBRestRequest; -import jalview.ws.uimodel.PDBRestResponse; -import jalview.ws.uimodel.PDBRestResponse.PDBResponseSummary; import java.awt.event.ItemEvent; import java.util.ArrayList; @@ -43,11 +48,15 @@ import java.util.Collection; import java.util.HashSet; import java.util.LinkedHashSet; import java.util.List; +import java.util.Objects; +import java.util.Set; +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; /** @@ -57,10 +66,12 @@ import javax.swing.table.AbstractTableModel; * */ @SuppressWarnings("serial") -public class StructureChooser extends GStructureChooser implements - IProgressIndicator +public class StructureChooser extends GStructureChooser + implements IProgressIndicator { - private boolean structuresDiscovered = false; + private static final String AUTOSUPERIMPOSE = "AUTOSUPERIMPOSE"; + + private static int MAX_QLENGTH = 7820; private SequenceI selectedSequence; @@ -68,16 +79,20 @@ public class StructureChooser extends GStructureChooser implements private IProgressIndicator progressIndicator; - private Collection discoveredStructuresSet; + private Collection discoveredStructuresSet; - private PDBRestRequest lastPdbRequest; + private FTSRestRequest lastPdbRequest; - private PDBRestClient pdbRestCleint; + private FTSRestClientI pdbRestClient; private String selectedPdbFileName; private boolean isValidPBDEntry; + private boolean cachedPDBExists; + + private static StructureViewer lastTargetedView = null; + public StructureChooser(SequenceI[] selectedSeqs, SequenceI selectedSeq, AlignmentPanel ap) { @@ -91,13 +106,17 @@ public class StructureChooser extends GStructureChooser implements /** * 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, cachedPDBExists); Thread discoverPDBStructuresThread = new Thread(new Runnable() { @Override @@ -108,11 +127,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(); - populateFilterComboBox(); + // revise filter options if no results were found + populateFilterComboBox(isStructuresDiscovered(), cachedPDBExists); + discoverStructureViews(); updateProgressIndicator(null, startTime); mainFrame.setVisible(true); updateCurrentView(); @@ -122,6 +142,59 @@ 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 @@ -129,7 +202,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) { @@ -141,28 +214,32 @@ 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(); - Collection wantedFields = PDBDocFieldPreferences + pdbRestClient = PDBFTSRestClient.getInstance(); + Collection wantedFields = pdbDocFieldPrefs .getStructureSummaryFields(); - discoveredStructuresSet = new LinkedHashSet(); - HashSet errors = new HashSet(); + discoveredStructuresSet = new LinkedHashSet<>(); + HashSet errors = new HashSet<>(); for (SequenceI seq : selectedSequences) { - PDBRestRequest pdbRequest = new PDBRestRequest(); + 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); - pdbRestCleint = new PDBRestClient(); - PDBRestResponse resultList; + FTSRestResponse resultList; try { - resultList = pdbRestCleint.executeRequest(pdbRequest); + resultList = pdbRestClient.executeRequest(pdbRequest); } catch (Exception e) { e.printStackTrace(); @@ -183,9 +260,8 @@ public class StructureChooser extends GStructureChooser implements if (discoveredStructuresSet != null && !discoveredStructuresSet.isEmpty()) { - tbl_summary.setModel(PDBRestResponse.getTableModel(lastPdbRequest, - discoveredStructuresSet)); - structuresDiscovered = true; + getResultTable().setModel(FTSRestResponse + .getTableModel(lastPdbRequest, discoveredStructuresSet)); noOfStructuresFound = discoveredStructuresSet.size(); mainFrame.setTitle(MessageManager.formatMessage( "label.structure_chooser_no_of_structures", @@ -202,16 +278,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 @@ -227,7 +303,7 @@ public class StructureChooser extends GStructureChooser implements } } } - + cachedPDBExists = !entries.isEmpty(); PDBEntryTableModel tableModelx = new PDBEntryTableModel(entries); tbl_local_pdb.setModel(tableModelx); } @@ -240,54 +316,49 @@ public class StructureChooser extends GStructureChooser implements * @return the built query string */ - public static String buildQuery(SequenceI seq) + static String buildQuery(SequenceI seq) { boolean isPDBRefsFound = false; boolean isUniProtRefsFound = false; StringBuilder queryBuilder = new StringBuilder(); - HashSet seqRefs = new LinkedHashSet(); + Set seqRefs = new LinkedHashSet<>(); - if (seq.getAllPDBEntries() != null) + if (seq.getAllPDBEntries() != null + && queryBuilder.length() < MAX_QLENGTH) { for (PDBEntry entry : seq.getAllPDBEntries()) { if (isValidSeqName(entry.getId())) { - queryBuilder.append(PDBRestClient.PDBDocField.PDB_ID.getCode()) - .append(":") -.append(entry.getId().toLowerCase()) + queryBuilder.append("pdb_id:").append(entry.getId().toLowerCase()) .append(" OR "); isPDBRefsFound = true; - // seqRefs.add(entry.getId()); } } } - if (seq.getDBRefs() != null && seq.getDBRefs().length != 0) + List refs = seq.getDBRefs(); + if (refs != null && refs.size() != 0) { - for (DBRefEntry dbRef : seq.getDBRefs()) + for (int ib = 0, nb = refs.size(); ib < nb; ib++) { - if (isValidSeqName(getDBRefId(dbRef))) + DBRefEntry dbRef = refs.get(ib); + if (isValidSeqName(getDBRefId(dbRef)) + && queryBuilder.length() < MAX_QLENGTH) { if (dbRef.getSource().equalsIgnoreCase(DBRefSource.UNIPROT)) { - queryBuilder - .append(PDBRestClient.PDBDocField.UNIPROT_ACCESSION - .getCode()).append(":") - .append(getDBRefId(dbRef)) - .append(" OR "); - queryBuilder - .append(PDBRestClient.PDBDocField.UNIPROT_ID.getCode()) - .append(":") + 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(PDBRestClient.PDBDocField.PDB_ID.getCode()) - .append(":").append(getDBRefId(dbRef).toLowerCase()) - .append(" OR "); + queryBuilder.append("pdb_id:") + .append(getDBRefId(dbRef).toLowerCase()).append(" OR "); isPDBRefsFound = true; } else @@ -301,6 +372,7 @@ public class StructureChooser extends GStructureChooser implements if (!isPDBRefsFound && !isUniProtRefsFound) { String seqName = seq.getName(); + seqName = sanitizeSeqName(seqName); String[] names = seqName.toLowerCase().split("\\|"); for (String name : names) { @@ -328,13 +400,27 @@ public class StructureChooser extends GStructureChooser implements } /** + * 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) + static boolean isValidSeqName(String seqName) { // System.out.println("seqName : " + seqName); String ignoreList = "pdb,uniprot,swiss-prot"; @@ -357,7 +443,7 @@ public class StructureChooser extends GStructureChooser implements return true; } - public static String getDBRefId(DBRefEntry dbRef) + static String getDBRefId(DBRefEntry dbRef) { String ref = dbRef.getAccessionId().replaceAll("GO:", ""); return ref; @@ -369,7 +455,7 @@ public class StructureChooser extends GStructureChooser implements * @param fieldToFilterBy * the field to filter by */ - public void filterResultSet(final String fieldToFilterBy) + void filterResultSet(final String fieldToFilterBy) { Thread filterThread = new Thread(new Runnable() { @@ -377,30 +463,18 @@ public class StructureChooser extends GStructureChooser implements public void run() { long startTime = System.currentTimeMillis(); + pdbRestClient = PDBFTSRestClient.getInstance(); lbl_loading.setVisible(true); - Collection wantedFields = PDBDocFieldPreferences + Collection wantedFields = pdbDocFieldPrefs .getStructureSummaryFields(); - Collection filteredResponse = new HashSet(); - HashSet errors = new HashSet(); - // try - // { - // PDBDocField fiterField = PDBRestClient - // .getPDBDocFieldByCode(fieldToFilterBy); - // if (!wantedFields.contains(fiterField)) - // { - // wantedFields.add(fiterField); - // } - // } catch (Exception e) - // { - // e.printStackTrace(); - // } + Collection filteredResponse = new HashSet<>(); + HashSet errors = new HashSet<>(); for (SequenceI seq : selectedSequences) { - PDBRestRequest pdbRequest = new PDBRestRequest(); + FTSRestRequest pdbRequest = new FTSRestRequest(); if (fieldToFilterBy.equalsIgnoreCase("uniprot_coverage")) { - System.out.println(">>>>>> Filtering with uniprot coverate"); pdbRequest.setAllowEmptySeq(false); pdbRequest.setResponseSize(1); pdbRequest.setFieldToSearchBy("("); @@ -422,11 +496,10 @@ public class StructureChooser extends GStructureChooser implements pdbRequest.setWantedFields(wantedFields); pdbRequest.setAssociatedSequence(seq); } - pdbRestCleint = new PDBRestClient(); - PDBRestResponse resultList; + FTSRestResponse resultList; try { - resultList = pdbRestCleint.executeRequest(pdbRequest); + resultList = pdbRestClient.executeRequest(pdbRequest); } catch (Exception e) { e.printStackTrace(); @@ -446,14 +519,20 @@ 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); - tbl_summary.setModel(PDBRestResponse.getTableModel( - lastPdbRequest, reorderedStructuresSet)); - + getResultTable().setModel(FTSRestResponse + .getTableModel(lastPdbRequest, reorderedStructuresSet)); + + FTSRestResponse.configureTableColumn(getResultTable(), + wantedFields, tempUserPrefs); + getResultTable().getColumn("Ref Sequence").setPreferredWidth(120); + getResultTable().getColumn("Ref Sequence").setMinWidth(100); + getResultTable().getColumn("Ref Sequence").setMaxWidth(200); // Update table selection model here - tbl_summary.addRowSelectionInterval(0, filterResponseCount - 1); + getResultTable().addRowSelectionInterval(0, + filterResponseCount - 1); mainFrame.setTitle(MessageManager.formatMessage( "label.structure_chooser_filter_time", totalTime)); } @@ -468,11 +547,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); } } @@ -488,14 +565,16 @@ 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))); @@ -513,36 +592,55 @@ public class StructureChooser extends GStructureChooser implements * Populates the filter combo-box options dynamically depending on discovered * structures */ - @Override - protected void populateFilterComboBox() + protected void populateFilterComboBox(boolean haveData, + boolean cachedPDBExist) { - if (isStructuresDiscovered()) + /* + * temporarily suspend the change listener behaviour + */ + cmb_filterOption.removeItemListener(this); + + cmb_filterOption.removeAllItems(); + if (haveData) + { + cmb_filterOption.addItem(new FilterOption( + MessageManager.getString("label.best_quality"), + "overall_quality", VIEWS_FILTER, false)); + cmb_filterOption.addItem(new FilterOption( + MessageManager.getString("label.best_resolution"), + "resolution", VIEWS_FILTER, false)); + cmb_filterOption.addItem(new FilterOption( + MessageManager.getString("label.most_protein_chain"), + "number_of_protein_chains", VIEWS_FILTER, false)); + cmb_filterOption.addItem(new FilterOption( + MessageManager.getString("label.most_bound_molecules"), + "number_of_bound_molecules", VIEWS_FILTER, false)); + cmb_filterOption.addItem(new FilterOption( + MessageManager.getString("label.most_polymer_residues"), + "number_of_polymer_residues", VIEWS_FILTER, true)); + } + 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) { - cmb_filterOption.addItem(new FilterOption("Best Quality", - PDBDocField.OVERALL_QUALITY.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most UniProt Coverage", - PDBDocField.UNIPROT_COVERAGE.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Best Resolution", - PDBDocField.RESOLUTION.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Protein Chain", - PDBDocField.PROTEIN_CHAIN_COUNT.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Bound Molecules", - PDBDocField.BOUND_MOLECULE_COUNT.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Most Polymer Residues", - PDBDocField.POLYMER_RESIDUE_COUNT.getCode(), VIEWS_FILTER)); + 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); } /** * Updates the displayed view based on the selected filter option */ - @Override protected void updateCurrentView() { FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption @@ -570,28 +668,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 (tbl_summary.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) @@ -602,12 +709,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(); @@ -615,27 +731,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); } @@ -650,19 +764,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); } } @@ -674,7 +787,7 @@ public class StructureChooser extends GStructureChooser implements } @Override - public void cmbAssSeqStateChanged() + protected void cmbAssSeqStateChanged() { validateSelections(); } @@ -701,161 +814,348 @@ 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 */ - @Override - public void ok_ActionPerformed() + public boolean selectStructure(String... pdbids) { - final long progressSessionId = System.currentTimeMillis(); - final StructureSelectionManager ssm = ap.getStructureSelectionManager(); - ssm.setProgressIndicator(this); - ssm.setProgressSessionId(progressSessionId); - new Thread(new Runnable() - { - @Override - public void run() - { + boolean found = false; + FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption .getSelectedItem()); String currentView = selectedFilterOpt.getView(); - if (currentView == VIEWS_FILTER) + 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++) { - int pdbIdColIndex = tbl_summary.getColumn( - PDBRestClient.PDBDocField.PDB_ID.getName()).getModelIndex(); - int refSeqColIndex = tbl_summary.getColumn("Ref Sequence") - .getModelIndex(); - int[] selectedRows = tbl_summary.getSelectedRows(); - PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length]; - int count = 0; - ArrayList selectedSeqsToView = new ArrayList(); - for (int row : selectedRows) + for (int p = 0; p < pdbids.length; p++) { - String pdbIdStr = tbl_summary.getValueAt(row, pdbIdColIndex) - .toString(); - SequenceI selectedSeq = (SequenceI) tbl_summary.getValueAt(row, - refSeqColIndex); - selectedSeqsToView.add(selectedSeq); - PDBEntry pdbEntry = selectedSeq.getPDBEntry(pdbIdStr); - if (pdbEntry == null) + if (String.valueOf(restable.getValueAt(r, pdbIdColIndex)) + .equalsIgnoreCase(pdbids[p])) { - pdbEntry = new PDBEntry(); - pdbEntry.setId(pdbIdStr); - pdbEntry.setType(PDBEntry.Type.PDB); - selectedSeq.getDatasetSequence().addPDBId(pdbEntry); + restable.setRowSelectionInterval(r, r); + found = true; } - pdbEntriesToView[count++] = pdbEntry; } - SequenceI[] selectedSeqs = selectedSeqsToView - .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); } - else if (currentView == VIEWS_LOCAL_PDB) + return found; + } + + /** + * Handles the 'New View' action + */ + @Override + protected void newView_ActionPerformed() + { + 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(); + + Runnable viewStruc = new Runnable() { - int[] selectedRows = tbl_local_pdb.getSelectedRows(); - PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length]; - int count = 0; - int pdbIdColIndex = tbl_local_pdb.getColumn( - PDBRestClient.PDBDocField.PDB_ID.getName()).getModelIndex(); - int refSeqColIndex = tbl_local_pdb.getColumn("Ref Sequence") - .getModelIndex(); - ArrayList selectedSeqsToView = new ArrayList(); - for (int row : selectedRows) + @Override + public void run() { - PDBEntry pdbEntry = (PDBEntry) tbl_local_pdb.getValueAt(row, - pdbIdColIndex); - pdbEntriesToView[count++] = pdbEntry; - SequenceI selectedSeq = (SequenceI) tbl_local_pdb.getValueAt(row, - refSeqColIndex); - selectedSeqsToView.add(selectedSeq); + 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 = restable.getColumn("PDB Id") + .getModelIndex(); + int refSeqColIndex = restable.getColumn("Ref Sequence") + .getModelIndex(); + int[] selectedRows = restable.getSelectedRows(); + PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length]; + int count = 0; + List selectedSeqsToView = new ArrayList<>(); + for (int row : selectedRows) + { + String pdbIdStr = restable + .getValueAt(row, pdbIdColIndex).toString(); + SequenceI selectedSeq = (SequenceI) restable + .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; + } + SequenceI[] selectedSeqs = selectedSeqsToView + .toArray(new SequenceI[selectedSeqsToView.size()]); + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + selectedSeqs); + } + else if (currentView == VIEWS_LOCAL_PDB) + { + int[] selectedRows = tbl_local_pdb.getSelectedRows(); + PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length]; + int count = 0; + int pdbIdColIndex = tbl_local_pdb.getColumn("PDB Id") + .getModelIndex(); + int refSeqColIndex = tbl_local_pdb.getColumn("Ref Sequence") + .getModelIndex(); + 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); + selectedSeqsToView.add(selectedSeq); + } + SequenceI[] selectedSeqs = selectedSeqsToView + .toArray(new SequenceI[selectedSeqsToView.size()]); + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + selectedSeqs); + } + else if (currentView == VIEWS_ENTER_ID) + { + SequenceI userSelectedSeq = ((AssociateSeqOptions) idInputAssSeqPanel + .getCmb_assSeq().getSelectedItem()).getSequence(); + if (userSelectedSeq != null) + { + selectedSequence = userSelectedSeq; + } + String pdbIdStr = txt_search.getText(); + PDBEntry pdbEntry = selectedSequence.getPDBEntry(pdbIdStr); + if (pdbEntry == null) + { + pdbEntry = new PDBEntry(); + if (pdbIdStr.split(":").length > 1) + { + pdbEntry.setId(pdbIdStr.split(":")[0]); + pdbEntry.setChainCode(pdbIdStr.split(":")[1].toUpperCase()); + } + else + { + pdbEntry.setId(pdbIdStr); + } + pdbEntry.setType(PDBEntry.Type.PDB); + selectedSequence.getDatasetSequence().addPDBId(pdbEntry); + } + + PDBEntry[] pdbEntriesToView = new PDBEntry[] { pdbEntry }; + sViewer = launchStructureViewer(ssm, pdbEntriesToView, ap, + new SequenceI[] + { selectedSequence }); + } + else if (currentView == VIEWS_FROM_FILE) + { + SequenceI userSelectedSeq = ((AssociateSeqOptions) fileChooserAssSeqPanel + .getCmb_assSeq().getSelectedItem()).getSequence(); + if (userSelectedSeq != null) + { + selectedSequence = userSelectedSeq; + } + PDBEntry fileEntry = new AssociatePdbFileWithSeq() + .associatePdbWithSeq(selectedPdbFileName, + DataSourceType.FILE, selectedSequence, true, + Desktop.instance); + + sViewer = launchStructureViewer( + ssm, new PDBEntry[] + { fileEntry }, ap, + new SequenceI[] + { selectedSequence }); + } + SwingUtilities.invokeLater(new Runnable() + { + @Override + public void run() + { + closeAction(preferredHeight); + mainFrame.dispose(); + } + }); } - SequenceI[] selectedSeqs = selectedSeqsToView - .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); - } - else if (currentView == VIEWS_ENTER_ID) + }; + Thread runner = new Thread(viewStruc); + runner.start(); + if (waitUntilFinished) { - SequenceI userSelectedSeq = ((AssociateSeqOptions) idInputAssSeqPanel - .getCmb_assSeq().getSelectedItem()).getSequence(); - if (userSelectedSeq != null) + while (sViewer == null ? runner.isAlive() + : (sViewer.sview == null ? true + : !sViewer.sview.hasMapping())) { - selectedSequence = userSelectedSeq; - } + try + { + Thread.sleep(300); + } catch (InterruptedException ie) + { - String pdbIdStr = txt_search.getText(); - PDBEntry pdbEntry = selectedSequence.getPDBEntry(pdbIdStr); - if (pdbEntry == null) - { - pdbEntry = new PDBEntry(); - pdbEntry.setId(pdbIdStr); - pdbEntry.setType(PDBEntry.Type.PDB); - selectedSequence.getDatasetSequence().addPDBId(pdbEntry); + } } - - PDBEntry[] pdbEntriesToView = new PDBEntry[] { pdbEntry }; - launchStructureViewer(ssm, pdbEntriesToView, ap, - new SequenceI[] { selectedSequence }); } - else if (currentView == VIEWS_FROM_FILE) + } + + private PDBEntry getFindEntry(String id, Vector pdbEntries) + { + Objects.requireNonNull(id); + Objects.requireNonNull(pdbEntries); + PDBEntry foundEntry = null; + for (PDBEntry entry : pdbEntries) { - SequenceI userSelectedSeq = ((AssociateSeqOptions) fileChooserAssSeqPanel - .getCmb_assSeq().getSelectedItem()).getSequence(); - if (userSelectedSeq != null) + if (entry.getId().equalsIgnoreCase(id)) { - selectedSequence = userSelectedSeq; + return entry; } - PDBEntry fileEntry = new AssociatePdbFileWithSeq() - .associatePdbWithSeq(selectedPdbFileName, - jalview.io.AppletFormatAdapter.FILE, - selectedSequence, true, Desktop.instance); - - launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, - new SequenceI[] { selectedSequence }); } - mainFrame.dispose(); - } - }).start(); + return foundEntry; + } + + /** + * 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; } - private void launchStructureViewer(StructureSelectionManager ssm, + /** + * 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("Launching PDB 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<>(); + 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 + // a known mapping between the PDBEntry and the sequence. for (SequenceI seq : sequences) { - if (seq.getSourceDBRef() == null) + PDBEntry pdbe = pdbEntriesToView[p++]; + if (pdbe != null && pdbe.getFile() != null) { - ssm.setProgressBar(null); - ssm.setProgressBar("Fetching Database refs.."); - new jalview.ws.DBRefFetcher(sequences, null, null, null, false) - .fetchDBRefs(true); - break; - } - } - } - if (pdbEntriesToView.length > 1) - { - ArrayList seqsMap = new ArrayList(); - for (SequenceI seq : sequences) + StructureMapping[] smm = ssm.getMapping(pdbe.getFile()); + if (smm != null && smm.length > 0) { - seqsMap.add(new SequenceI[] { seq }); + for (StructureMapping sm : smm) + { + if (sm.getSequence() == seq) + { + continue; + } + } } - SequenceI[][] collatedSeqs = seqsMap.toArray(new SequenceI[0][0]); - ssm.setProgressBar(null); - ssm.setProgressBar("Fetching PDB Structures for selected entries.."); - sViewer.viewStructures(pdbEntriesToView, collatedSeqs, alignPanel); } - else + if (seq.getPrimaryDBRefs().isEmpty()) { - ssm.setProgressBar(null); - ssm.setProgressBar("Fetching PDB Structure for " - + pdbEntriesToView[0].getId()); - sViewer.viewStructures(pdbEntriesToView[0], sequences, alignPanel); + seqsWithoutSourceDBRef.add(seq); + continue; } + } + if (!seqsWithoutSourceDBRef.isEmpty()) + { + int y = seqsWithoutSourceDBRef.size(); + setProgressBar(MessageManager.formatMessage( + "status.fetching_dbrefs_for_sequences_without_valid_refs", + 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) + { + setProgressBar(MessageManager.getString( + "status.fetching_3d_structures_for_selected_entries"), + progressId); + theViewer.viewStructures(pdbEntriesToView, sequences, alignPanel); + } + else + { + setProgressBar(MessageManager.formatMessage( + "status.fetching_3d_structures_for", + pdbEntriesToView[0].getId()),progressId); + theViewer.viewStructures(pdbEntriesToView[0], sequences, alignPanel); + } + setProgressBar(null, progressId); + // remember the last viewer we used... + lastTargetedView = theViewer; + return theViewer; } /** @@ -863,12 +1163,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) { @@ -887,47 +1188,48 @@ public class StructureChooser extends GStructureChooser implements } } - public boolean isStructuresDiscovered() + protected boolean isStructuresDiscovered() { - return structuresDiscovered; + return discoveredStructuresSet != null + && !discoveredStructuresSet.isEmpty(); } - public void setStructuresDiscovered(boolean structuresDiscovered) - { - this.structuresDiscovered = structuresDiscovered; - } - - 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() { + String text = txt_search.getText().trim(); + if (text.length() >= PDB_ID_MIN) new Thread() { - @Override + + @Override public void run() { errorWarning.setLength(0); isValidPBDEntry = false; - if (txt_search.getText().length() > 0) + if (text.length() > 0) { - List wantedFields = new ArrayList(); - wantedFields.add(PDBDocField.PDB_ID); - PDBRestRequest pdbRequest = new PDBRestRequest(); + 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(txt_search.getText() + ")"); + pdbRequest.setSearchTerm(searchTerm + ")"); pdbRequest.setAssociatedSequence(selectedSequence); - pdbRestCleint = new PDBRestClient(); - PDBRestResponse resultList; + pdbRestClient = PDBFTSRestClient.getInstance(); + wantedFields.add(pdbRestClient.getPrimaryKeyColumn()); + FTSRestResponse resultList; try { - resultList = pdbRestCleint.executeRequest(pdbRequest); + resultList = pdbRestClient.executeRequest(pdbRequest); } catch (Exception e) { errorWarning.append(e.getMessage()); @@ -948,7 +1250,7 @@ public class StructureChooser extends GStructureChooser implements } @Override - public void tabRefresh() + protected void tabRefresh() { if (selectedSequences != null) { @@ -958,8 +1260,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(); @@ -968,13 +1271,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 @@ -1015,8 +1319,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(); @@ -1084,4 +1388,9 @@ public class StructureChooser extends GStructureChooser implements { return progressBar.operationInProgress(); } + + public JalviewStructureDisplayI getOpenedStructureViewer() + { + return sViewer == null ? null : sViewer.sview; + } }