src/jalview/gui/AssociatePdbFileWithSeq.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.StructureSelectionManagerProvider;
  24 import jalview.datamodel.PDBEntry;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.io.DataSourceType;
  27 import jalview.io.StructureFile;
  28 import jalview.structure.StructureSelectionManager;
  29 import jalview.util.MessageManager;
  30
  31 import javax.swing.JOptionPane;
  32
  33 /**
  34  * GUI related routines for associating PDB files with sequences
  35  *
  36  * @author JimP
  37  *
  38  */
  39 public class AssociatePdbFileWithSeq
  40 {
  41
  42   /**
  43    * assocate the given PDB file with
  44    *
  45    * @param choice
  46    * @param sequence
  47    */
  48   public PDBEntry associatePdbWithSeq(String choice, DataSourceType file,
  49           SequenceI sequence, boolean prompt,
  50           StructureSelectionManagerProvider ssmp)
  51   {
  52     PDBEntry entry = new PDBEntry();
  53     StructureFile pdbfile = null;
  54     pdbfile = StructureSelectionManager.getStructureSelectionManager(ssmp)
  55             .setMapping(false, new SequenceI[] { sequence }, null, choice,
  56                     file);
  57     if (pdbfile == null)
  58     {
  59       // stacktrace already thrown so just return
  60       return null;
  61     }
  62     if (pdbfile.getId() == null)
  63     {
  64       String reply = null;
  65
  66       if (prompt)
  67       {
  68         reply = JvOptionPane.showInternalInputDialog(Desktop.desktop,
  69                 MessageManager
  70                         .getString("label.couldnt_find_pdb_id_in_file"),
  71                 MessageManager.getString("label.no_pdb_id_in_file"),
  72                 JvOptionPane.QUESTION_MESSAGE);
  73       }
  74       if (reply == null)
  75       {
  76         return null;
  77       }
  78
  79       entry.setId(reply);
  80     }
  81     else
  82     {
  83       entry.setId(pdbfile.getId());
  84     }
  85     entry.setType(PDBEntry.Type.FILE);
  86
  87     if (pdbfile != null)
  88     {
  89       entry.setFile(choice);
  90       sequence.getDatasetSequence().addPDBId(entry);
  91       StructureSelectionManager.getStructureSelectionManager(ssmp)
  92               .registerPDBEntry(entry);
  93     }
  94     return entry;
  95   }
  96 }