X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FStructureChooser.java;h=89ba84b210fd36916710fb15cfbfb7d4f6937f16;hb=364f1cf36d12a069be963ec0166c9170e8b6f365;hp=510ce782e83017a02a2f2ab6a74c768c57e339e4;hpb=02af7d241e684c2712110004fac44e3588f59d9c;p=jalview.git diff --git a/src/jalview/gui/StructureChooser.java b/src/jalview/gui/StructureChooser.java index 510ce78..89ba84b 100644 --- a/src/jalview/gui/StructureChooser.java +++ b/src/jalview/gui/StructureChooser.java @@ -1,7 +1,6 @@ /* - - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -22,7 +21,9 @@ package jalview.gui; +import jalview.bin.Jalview; import jalview.datamodel.DBRefEntry; +import jalview.datamodel.DBRefSource; import jalview.datamodel.PDBEntry; import jalview.datamodel.SequenceI; import jalview.jbgui.GStructureChooser; @@ -31,6 +32,7 @@ import jalview.structure.StructureSelectionManager; import jalview.util.MessageManager; import jalview.ws.dbsources.PDBRestClient; import jalview.ws.dbsources.PDBRestClient.PDBDocField; +import jalview.ws.sifts.SiftsSettings; import jalview.ws.uimodel.PDBRestRequest; import jalview.ws.uimodel.PDBRestResponse; import jalview.ws.uimodel.PDBRestResponse.PDBResponseSummary; @@ -41,6 +43,8 @@ import java.util.Collection; import java.util.HashSet; import java.util.LinkedHashSet; import java.util.List; +import java.util.Objects; +import java.util.Vector; import javax.swing.JCheckBox; import javax.swing.JComboBox; @@ -55,7 +59,8 @@ import javax.swing.table.AbstractTableModel; * */ @SuppressWarnings("serial") -public class StructureChooser extends GStructureChooser +public class StructureChooser extends GStructureChooser implements + IProgressIndicator { private boolean structuresDiscovered = false; @@ -75,7 +80,6 @@ public class StructureChooser extends GStructureChooser private boolean isValidPBDEntry; - public StructureChooser(SequenceI[] selectedSeqs, SequenceI selectedSeq, AlignmentPanel ap) { @@ -91,6 +95,11 @@ public class StructureChooser extends GStructureChooser */ public void init() { + if (!Jalview.isHeadlessMode()) + { + progressBar = new ProgressBar(this.statusPanel, this.statusBar); + } + Thread discoverPDBStructuresThread = new Thread(new Runnable() { @Override @@ -147,7 +156,7 @@ public class StructureChooser extends GStructureChooser PDBRestRequest pdbRequest = new PDBRestRequest(); pdbRequest.setAllowEmptySeq(false); pdbRequest.setResponseSize(500); - pdbRequest.setFieldToSearchBy("(text:"); + pdbRequest.setFieldToSearchBy("("); pdbRequest.setWantedFields(wantedFields); pdbRequest.setSearchTerm(buildQuery(seq) + ")"); pdbRequest.setAssociatedSequence(seq); @@ -210,7 +219,8 @@ public class StructureChooser extends GStructureChooser if (seq.getDatasetSequence() != null && seq.getDatasetSequence().getAllPDBEntries() != null) { - for (PDBEntry pdbEntry : seq.getDatasetSequence().getAllPDBEntries()) + for (PDBEntry pdbEntry : seq.getDatasetSequence() + .getAllPDBEntries()) { if (pdbEntry.getFile() != null) { @@ -224,7 +234,6 @@ public class StructureChooser extends GStructureChooser tbl_local_pdb.setModel(tableModelx); } - /** * Builds a query string for a given sequences using its DBRef entries * @@ -235,18 +244,10 @@ public class StructureChooser extends GStructureChooser public static String buildQuery(SequenceI seq) { + boolean isPDBRefsFound = false; + boolean isUniProtRefsFound = false; + StringBuilder queryBuilder = new StringBuilder(); HashSet seqRefs = new LinkedHashSet(); - String seqName = seq.getName(); - String[] names = seqName.toLowerCase().split("\\|"); - for (String name : names) - { - // System.out.println("Found name : " + name); - name.trim(); - if (isValidSeqName(name)) - { - seqRefs.add(name); - } - } if (seq.getAllPDBEntries() != null) { @@ -254,44 +255,97 @@ public class StructureChooser extends GStructureChooser { if (isValidSeqName(entry.getId())) { - seqRefs.add(entry.getId()); + queryBuilder.append(PDBRestClient.PDBDocField.PDB_ID.getCode()) + .append(":") +.append(entry.getId().toLowerCase()) + .append(" OR "); + isPDBRefsFound = true; + // seqRefs.add(entry.getId()); } } } - if (seq.getDBRef() != null && seq.getDBRef().length != 0) + if (seq.getDBRefs() != null && seq.getDBRefs().length != 0) { - int count = 0; - for (DBRefEntry dbRef : seq.getDBRef()) + for (DBRefEntry dbRef : seq.getDBRefs()) { if (isValidSeqName(getDBRefId(dbRef))) { - seqRefs.add(getDBRefId(dbRef)); - } - ++count; - if (count > 10) - { - break; + 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(":") + .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 "); + isPDBRefsFound = true; + } + else + { + seqRefs.add(getDBRefId(dbRef)); + } } } } - StringBuilder queryBuilder = new StringBuilder(); - for (String seqRef : seqRefs) + if (!isPDBRefsFound && !isUniProtRefsFound) { - queryBuilder.append("text:").append(seqRef).append(" OR "); + 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 "); + int endIndex = queryBuilder.lastIndexOf(" OR "); if (queryBuilder.toString().length() < 6) { return null; } - String query = queryBuilder.toString().substring(5, endIndex); + String query = queryBuilder.toString().substring(0, endIndex); return query; } /** + * Remove the following special characters from input string +, -, &, |, !, (, + * ), {, }, [, ], ^, ", ~, *, ?, :, \ + * + * @param seqName + * @return + */ + private 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 * @@ -346,17 +400,34 @@ public class StructureChooser extends GStructureChooser .getStructureSummaryFields(); Collection filteredResponse = new HashSet(); HashSet errors = new HashSet(); + for (SequenceI seq : selectedSequences) { PDBRestRequest pdbRequest = new PDBRestRequest(); - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(1); - pdbRequest.setFieldToSearchBy("(text:"); - pdbRequest.setFieldToSortBy(fieldToFilterBy, - !chk_invertFilter.isSelected()); - pdbRequest.setSearchTerm(buildQuery(seq) + ")"); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setAssociatedSequence(seq); + if (fieldToFilterBy.equalsIgnoreCase("uniprot_coverage")) + { + System.out.println(">>>>>> Filtering with uniprot coverate"); + 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); + } pdbRestCleint = new PDBRestClient(); PDBRestResponse resultList; try @@ -390,14 +461,12 @@ public class StructureChooser extends GStructureChooser // Update table selection model here tbl_summary.addRowSelectionInterval(0, filterResponseCount - 1); mainFrame.setTitle(MessageManager.formatMessage( - "label.structure_chooser_filter_time", - totalTime)); + "label.structure_chooser_filter_time", totalTime)); } else { mainFrame.setTitle(MessageManager.formatMessage( - "label.structure_chooser_filter_time", - totalTime)); + "label.structure_chooser_filter_time", totalTime)); if (errors.size() > 0) { StringBuilder errorMsg = new StringBuilder(); @@ -405,7 +474,9 @@ public class StructureChooser extends GStructureChooser { errorMsg.append(error).append("\n"); } - JOptionPane.showMessageDialog(null, errorMsg.toString(), + JOptionPane.showMessageDialog( + null, + errorMsg.toString(), MessageManager.getString("label.pdb_web-service_error"), JOptionPane.ERROR_MESSAGE); } @@ -422,6 +493,7 @@ public class StructureChooser extends GStructureChooser /** * Handles action event for btn_pdbFromFile */ + @Override public void pdbFromFile_actionPerformed() { jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser( @@ -447,21 +519,22 @@ public class StructureChooser extends GStructureChooser * Populates the filter combo-box options dynamically depending on discovered * structures */ + @Override protected void populateFilterComboBox() { if (isStructuresDiscovered()) { cmb_filterOption.addItem(new FilterOption("Best Quality", PDBDocField.OVERALL_QUALITY.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Best UniProt Coverage", + cmb_filterOption.addItem(new FilterOption("Most UniProt Coverage", PDBDocField.UNIPROT_COVERAGE.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Highest Resolution", + cmb_filterOption.addItem(new FilterOption("Best Resolution", PDBDocField.RESOLUTION.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Highest Protein Chain", + cmb_filterOption.addItem(new FilterOption("Most Protein Chain", PDBDocField.PROTEIN_CHAIN_COUNT.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Highest Bound Molecules", + cmb_filterOption.addItem(new FilterOption("Most Bound Molecules", PDBDocField.BOUND_MOLECULE_COUNT.getCode(), VIEWS_FILTER)); - cmb_filterOption.addItem(new FilterOption("Highest Polymer Residues", + cmb_filterOption.addItem(new FilterOption("Most Polymer Residues", PDBDocField.POLYMER_RESIDUE_COUNT.getCode(), VIEWS_FILTER)); } cmb_filterOption.addItem(new FilterOption("Enter PDB Id", "-", @@ -475,6 +548,7 @@ public class StructureChooser extends GStructureChooser /** * Updates the displayed view based on the selected filter option */ + @Override protected void updateCurrentView() { FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption @@ -505,6 +579,7 @@ public class StructureChooser extends GStructureChooser * Validates user selection and activates the view button if all parameters * are correct */ + @Override public void validateSelections() { FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption @@ -546,9 +621,9 @@ public class StructureChooser extends GStructureChooser lbl_pdbManualFetchStatus.setToolTipText(""); if (txt_search.getText().length() > 0) { - lbl_pdbManualFetchStatus.setToolTipText(JvSwingUtils.wrapTooltip( - true, MessageManager.formatMessage( - "info.no_pdb_entry_found_for", + lbl_pdbManualFetchStatus + .setToolTipText(JvSwingUtils.wrapTooltip(true, MessageManager + .formatMessage("info.no_pdb_entry_found_for", txt_search.getText()))); } @@ -637,6 +712,15 @@ public class StructureChooser extends GStructureChooser @Override public void ok_ActionPerformed() { + final long progressSessionId = System.currentTimeMillis(); + final StructureSelectionManager ssm = ap.getStructureSelectionManager(); + ssm.setProgressIndicator(this); + ssm.setProgressSessionId(progressSessionId); + new Thread(new Runnable() + { + @Override + public void run() + { FilterOption selectedFilterOpt = ((FilterOption) cmb_filterOption .getSelectedItem()); String currentView = selectedFilterOpt.getView(); @@ -657,7 +741,12 @@ public class StructureChooser extends GStructureChooser SequenceI selectedSeq = (SequenceI) tbl_summary.getValueAt(row, refSeqColIndex); selectedSeqsToView.add(selectedSeq); - PDBEntry pdbEntry = selectedSeq.getPDBEntry(pdbIdStr); + PDBEntry pdbEntry = selectedSeq.getPDBEntry(pdbIdStr); + if (pdbEntry == null) + { + pdbEntry = getFindEntry(pdbIdStr, + selectedSeq.getAllPDBEntries()); + } if (pdbEntry == null) { pdbEntry = new PDBEntry(); @@ -669,8 +758,7 @@ public class StructureChooser extends GStructureChooser } SequenceI[] selectedSeqs = selectedSeqsToView .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ap.getStructureSelectionManager(), - pdbEntriesToView, ap, selectedSeqs); + launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); } else if (currentView == VIEWS_LOCAL_PDB) { @@ -693,8 +781,7 @@ public class StructureChooser extends GStructureChooser } SequenceI[] selectedSeqs = selectedSeqsToView .toArray(new SequenceI[selectedSeqsToView.size()]); - launchStructureViewer(ap.getStructureSelectionManager(), - pdbEntriesToView, ap, selectedSeqs); + launchStructureViewer(ssm, pdbEntriesToView, ap, selectedSeqs); } else if (currentView == VIEWS_ENTER_ID) { @@ -715,11 +802,9 @@ public class StructureChooser extends GStructureChooser selectedSequence.getDatasetSequence().addPDBId(pdbEntry); } - PDBEntry[] pdbEntriesToView = new PDBEntry[] - { pdbEntry }; - launchStructureViewer(ap.getStructureSelectionManager(), - pdbEntriesToView, ap, new SequenceI[] - { selectedSequence }); + PDBEntry[] pdbEntriesToView = new PDBEntry[] { pdbEntry }; + launchStructureViewer(ssm, pdbEntriesToView, ap, + new SequenceI[] { selectedSequence }); } else if (currentView == VIEWS_FROM_FILE) { @@ -734,46 +819,76 @@ public class StructureChooser extends GStructureChooser jalview.io.AppletFormatAdapter.FILE, selectedSequence, true, Desktop.instance); - launchStructureViewer(ap.getStructureSelectionManager(), - new PDBEntry[] - { fileEntry }, ap, new SequenceI[] - { selectedSequence }); + launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, + new SequenceI[] { selectedSequence }); } mainFrame.dispose(); + } + }).start(); + } + + private PDBEntry getFindEntry(String id, Vector pdbEntries) + { + Objects.requireNonNull(id); + Objects.requireNonNull(pdbEntries); + PDBEntry foundEntry = null; + for (PDBEntry entry : pdbEntries) + { + if (entry.getId().equalsIgnoreCase(id)) + { + return entry; + } + } + return foundEntry; } - private void launchStructureViewer(final StructureSelectionManager ssm, + private void launchStructureViewer(StructureSelectionManager ssm, final PDBEntry[] pdbEntriesToView, - final AlignmentPanel alignPanel, final SequenceI[] sequences) + final AlignmentPanel alignPanel, SequenceI[] sequences) { + ssm.setProgressBar("Launching PDB structure viewer.."); final StructureViewer sViewer = new StructureViewer(ssm); - new Thread(new Runnable() + + if (SiftsSettings.isMapWithSifts()) { - public void run() + for (SequenceI seq : sequences) { + if (seq.getSourceDBRef() == 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) { - seqsMap.add(new SequenceI[] - { seq }); + seqsMap.add(new SequenceI[] { seq }); } 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 { + ssm.setProgressBar(null); + ssm.setProgressBar("Fetching PDB Structure for " + + pdbEntriesToView[0].getId()); sViewer.viewStructures(pdbEntriesToView[0], sequences, alignPanel); } - } - }).start(); } /** * Populates the combo-box used in associating manually fetched structures to * a unique sequence when more than one sequence selection is made. */ + @Override public void populateCmbAssociateSeqOptions( JComboBox cmb_assSeq, JLabel lbl_associateSeq) { @@ -818,42 +933,44 @@ public class StructureChooser extends GStructureChooser { new Thread() { + @Override public void run() { - errorWarning.setLength(0); - isValidPBDEntry = false; - if (txt_search.getText().length() > 0) - { - List wantedFields = new ArrayList(); - wantedFields.add(PDBDocField.PDB_ID); - PDBRestRequest pdbRequest = new PDBRestRequest(); - pdbRequest.setAllowEmptySeq(false); - pdbRequest.setResponseSize(1); - pdbRequest.setFieldToSearchBy("(pdb_id:"); - pdbRequest.setWantedFields(wantedFields); - pdbRequest.setSearchTerm(txt_search.getText() + ")"); - pdbRequest.setAssociatedSequence(selectedSequence); - pdbRestCleint = new PDBRestClient(); - PDBRestResponse resultList; - try - { - resultList = pdbRestCleint.executeRequest(pdbRequest); - } catch (Exception e) - { - errorWarning.append(e.getMessage()); - return; - } finally - { + errorWarning.setLength(0); + isValidPBDEntry = false; + if (txt_search.getText().length() > 0) + { + List wantedFields = new ArrayList(); + wantedFields.add(PDBDocField.PDB_ID); + PDBRestRequest pdbRequest = new PDBRestRequest(); + pdbRequest.setAllowEmptySeq(false); + pdbRequest.setResponseSize(1); + pdbRequest.setFieldToSearchBy("(pdb_id:"); + pdbRequest.setWantedFields(wantedFields); + pdbRequest + .setSearchTerm(txt_search.getText().toLowerCase() + ")"); + pdbRequest.setAssociatedSequence(selectedSequence); + pdbRestCleint = new PDBRestClient(); + PDBRestResponse resultList; + try + { + resultList = pdbRestCleint.executeRequest(pdbRequest); + } catch (Exception e) + { + errorWarning.append(e.getMessage()); + return; + } finally + { + validateSelections(); + } + if (resultList.getSearchSummary() != null + && resultList.getSearchSummary().size() > 0) + { + isValidPBDEntry = true; + } + } validateSelections(); } - if (resultList.getSearchSummary() != null - && resultList.getSearchSummary().size() > 0) - { - isValidPBDEntry = true; - } - } - validateSelections(); - } }.start(); } @@ -878,8 +995,7 @@ public class StructureChooser extends GStructureChooser 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; @@ -975,4 +1091,24 @@ public class StructureChooser extends GStructureChooser } } + + private IProgressIndicator progressBar; + + @Override + public void setProgressBar(String message, long id) + { + progressBar.setProgressBar(message, id); + } + + @Override + public void registerHandler(long id, IProgressIndicatorHandler handler) + { + progressBar.registerHandler(id, handler); + } + + @Override + public boolean operationInProgress() + { + return progressBar.operationInProgress(); + } }