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.StructureFile;
  27 import jalview.structure.StructureSelectionManager;
  28 import jalview.util.MessageManager;
  29
  30 import javax.swing.JOptionPane;
  31
  32 /**
  33  * GUI related routines for associating PDB files with sequences
  34  *
  35  * @author JimP
  36  *
  37  */
  38 public class AssociatePdbFileWithSeq
  39 {
  40
  41   /**
  42    * assocate the given PDB file with
  43    *
  44    * @param choice
  45    * @param sequence
  46    */
  47   public PDBEntry associatePdbWithSeq(String choice, String protocol,
  48           SequenceI sequence, boolean prompt,
  49           StructureSelectionManagerProvider ssmp)
  50   {
  51     PDBEntry entry = new PDBEntry();
  52     StructureFile pdbfile = null;
  53     pdbfile = StructureSelectionManager.getStructureSelectionManager(ssmp)
  54             .setMapping(false, new SequenceI[] { sequence }, null, choice,
  55                     protocol);
  56     if (pdbfile == null)
  57     {
  58       // stacktrace already thrown so just return
  59       return null;
  60     }
  61     if (pdbfile.getId() == null)
  62     {
  63       String reply = null;
  64
  65       if (prompt)
  66       {
  67         reply = JOptionPane.showInternalInputDialog(Desktop.desktop,
  68                 MessageManager
  69                         .getString("label.couldnt_find_pdb_id_in_file"),
  70                 MessageManager.getString("label.no_pdb_id_in_file"),
  71                 JOptionPane.QUESTION_MESSAGE);
  72       }
  73       if (reply == null)
  74       {
  75         return null;
  76       }
  77
  78       entry.setId(reply);
  79     }
  80     else
  81     {
  82       entry.setId(pdbfile.getId());
  83     }
  84     entry.setType(PDBEntry.Type.FILE);
  85
  86     if (pdbfile != null)
  87     {
  88       entry.setFile(choice);
  89       sequence.getDatasetSequence().addPDBId(entry);
  90       StructureSelectionManager.getStructureSelectionManager(ssmp)
  91               .registerPDBEntry(entry);
  92     }
  93     return entry;
  94   }
  95 }