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