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