Merge branch 'develop' into Release_2_8_2_Branch
[jalview.git] / src / jalview / gui / AssociatePdbFileWithSeq.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3  * Copyright (C) 2014 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 javax.swing.JOptionPane;
24 import jalview.datamodel.PDBEntry;
25 import jalview.datamodel.SequenceI;
26 import jalview.util.MessageManager;
27
28 /**
29  * GUI related routines for associating PDB files with sequences
30  * 
31  * @author JimP
32  * 
33  */
34 public class AssociatePdbFileWithSeq
35 {
36
37   /**
38    * assocate the given PDB file with
39    * 
40    * @param choice
41    * @param sequence
42    */
43   public PDBEntry associatePdbWithSeq(String choice, String protocol,
44           SequenceI sequence, boolean prompt)
45   {
46     PDBEntry entry = new PDBEntry();
47     MCview.PDBfile pdbfile = null;
48     try
49     {
50       // TODO JAL-674 extract secondary structure and transfer it to associated
51       // sequence
52       pdbfile = new MCview.PDBfile(false, false, choice, protocol);
53       if (pdbfile.id == null)
54       {
55         String reply = null;
56
57         if (prompt)
58         {
59           reply = JOptionPane.showInternalInputDialog(Desktop.desktop,
60                   MessageManager
61                           .getString("label.couldnt_find_pdb_id_in_file"),
62                   MessageManager.getString("label.no_pdb_id_in_file"),
63                   JOptionPane.QUESTION_MESSAGE);
64         }
65         if (reply == null)
66         {
67           return null;
68         }
69
70         entry.setId(reply);
71       }
72       else
73       {
74         entry.setId(pdbfile.id);
75       }
76
77     } catch (java.io.IOException ex)
78     {
79       ex.printStackTrace();
80     }
81
82     entry.setFile(choice);
83     sequence.getDatasetSequence().addPDBId(entry);
84     return entry;
85   }
86 }