src/jalview/io/SequenceFeatureFetcher.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.io;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import jalview.gui.*;\r
  24 \r
  25 import java.io.*;\r
  26 \r
  27 import java.util.*;\r
  28 \r
  29 import org.exolab.castor.mapping.Mapping;\r
  30 \r
  31 import org.exolab.castor.xml.*;\r
  32 import jalview.analysis.AlignSeq;\r
  33 \r
  34 \r
  35 \r
  36 /**\r
  37  * DOCUMENT ME!\r
  38  *\r
  39  * @author $author$\r
  40  * @version $Revision$\r
  41  */\r
  42 public class SequenceFeatureFetcher implements Runnable\r
  43 {\r
  44 \r
  45   AlignmentI align;\r
  46   AlignmentI dataset;\r
  47   AlignmentPanel ap;\r
  48   ArrayList unknownSequences;\r
  49   CutAndPasteTransfer output = new CutAndPasteTransfer();\r
  50   StringBuffer sbuffer = new StringBuffer();\r
  51   boolean uniprotFlag = false;\r
  52 \r
  53   public SequenceFeatureFetcher()\r
  54   {}\r
  55 \r
  56   public Vector getUniprotEntries(File file)\r
  57   {\r
  58 \r
  59     UniprotFile uni = new UniprotFile();\r
  60     try\r
  61     {\r
  62       // 1. Load the mapping information from the file\r
  63       Mapping map = new Mapping(uni.getClass().getClassLoader());\r
  64       java.net.URL url = getClass().getResource("/uniprot_mapping.xml");\r
  65       map.loadMapping(url);\r
  66 \r
  67       // 2. Unmarshal the data\r
  68       Unmarshaller unmar = new Unmarshaller();\r
  69       unmar.setIgnoreExtraElements(true);\r
  70       unmar.setMapping(map);\r
  71       uni = (UniprotFile) unmar.unmarshal(new FileReader(file));\r
  72 \r
  73     }\r
  74     catch (Exception e)\r
  75     {\r
  76       System.out.println("Error getUniprotEntries() "+e);\r
  77     }\r
  78     return uni.getUniprotEntries();\r
  79   }\r
  80 \r
  81   /**\r
  82    * Creates a new SequenceFeatureFetcher object.\r
  83    *\r
  84    * @param align DOCUMENT ME!\r
  85    * @param ap DOCUMENT ME!\r
  86    */\r
  87   public SequenceFeatureFetcher(AlignmentI align, AlignmentPanel ap)\r
  88   {\r
  89     unknownSequences = new ArrayList();\r
  90     this.align = align;\r
  91     this.dataset = align.getDataset();\r
  92     this.ap = ap;\r
  93 \r
  94     Thread thread = new Thread(this);\r
  95     thread.start();\r
  96   }\r
  97 \r
  98   /**\r
  99    * DOCUMENT ME!\r
 100    */\r
 101   public void run()\r
 102   {\r
 103     try\r
 104     {\r
 105       int seqIndex = 0;\r
 106       Vector sequences = dataset.getSequences();\r
 107 \r
 108       while (seqIndex < sequences.size())\r
 109       {\r
 110         Vector ids = new Vector();\r
 111 \r
 112         for (int i = 0; (seqIndex < sequences.size()) && (i < 50);\r
 113              seqIndex++, i++)\r
 114         {\r
 115           Sequence sequence = (Sequence) sequences.get(seqIndex);\r
 116           Vector uprefs = jalview.util.DBRefUtils.selectRefs(sequence.getDBRef(), new String[] { "Uniprot"});\r
 117           if (uprefs!=null)\r
 118           {\r
 119             // we know the id for this entry, so don't note its ID in the unknownSequences list\r
 120             for (int j=0,k=uprefs.size(); j<k; j++)\r
 121               ids.add(((DBRefEntry) uprefs.get(j)).getAccessionId());\r
 122             unknownSequences.add(sequence);\r
 123           } else {\r
 124             if (!ids.contains(sequence.getName()))\r
 125             {\r
 126               ids.add(sequence.getName());\r
 127               unknownSequences.add(sequence);\r
 128             }\r
 129           }\r
 130         }\r
 131 \r
 132         ///////////////////////////////////\r
 133         ///READ FROM EBI\r
 134         if (ids.size() > 0)\r
 135         {\r
 136           StringBuffer remainingIds = new StringBuffer("uniprot:");\r
 137           for (int i = 0; i < ids.size(); i++)\r
 138            {\r
 139              if(ids.get(i).toString().indexOf("|")>-1)\r
 140              {\r
 141                remainingIds.append(ids.get(i).toString().substring(\r
 142                    ids.get(i).toString().lastIndexOf("|") + 1));\r
 143                uniprotFlag = true;\r
 144              }\r
 145              remainingIds.append(ids.get(i) + ";");\r
 146            }\r
 147           EBIFetchClient ebi = new EBIFetchClient();\r
 148           File file = ebi.fetchDataAsFile(remainingIds.toString(),\r
 149                                           "xml", "raw");\r
 150 \r
 151 \r
 152 \r
 153           if (file != null)\r
 154           {\r
 155             ReadUniprotFile(file, ids);\r
 156           }\r
 157         }\r
 158       }\r
 159     }\r
 160     catch (Exception ex)\r
 161     {\r
 162       ex.printStackTrace();\r
 163     }\r
 164 \r
 165     if (sbuffer.length() > 0)\r
 166     {\r
 167       output.setText(\r
 168           "Your sequences have been matched to Uniprot. Some of the ids have been\n" +\r
 169           "altered, most likely the start/end residue will have been updated.\n" +\r
 170           "Save your alignment to maintain the updated id.\n\n" +\r
 171           sbuffer.toString());\r
 172       Desktop.addInternalFrame(output, "Sequence names updated ", 600, 300);\r
 173       // The above is the dataset, we must now find out the index\r
 174       // of the viewed sequence\r
 175 \r
 176     }\r
 177 \r
 178     promptBeforeBlast();\r
 179 \r
 180   }\r
 181 \r
 182 \r
 183   void promptBeforeBlast()\r
 184    {\r
 185      // This must be outside the run() body as java 1.5\r
 186      // will not return any value from the OptionPane to the expired thread.\r
 187       if (unknownSequences.size() > 0)\r
 188       {\r
 189        // int reply = javax.swing.JOptionPane.showConfirmDialog(\r
 190        //     Desktop.desktop, "Couldn't find a match for "+unknownSequences.size()+" sequences."\r
 191         //        +"\nPerform blast for unknown sequences?",\r
 192         //            "Blast for Unidentified Sequences",\r
 193         //             javax.swing.JOptionPane.YES_NO_OPTION, javax.swing.JOptionPane.QUESTION_MESSAGE);\r
 194      javax.swing.JOptionPane.showMessageDialog(\r
 195     Desktop.desktop, "Couldn't find a match for "+unknownSequences.size()+" sequences.",\r
 196             "Unidentified Sequences",\r
 197              javax.swing.JOptionPane.WARNING_MESSAGE);\r
 198 \r
 199 \r
 200       //  if(reply == javax.swing.JOptionPane.YES_OPTION)\r
 201      //    new WSWUBlastClient(ap, align, unknownSequences);\r
 202       }\r
 203 \r
 204 \r
 205     ap.repaint();\r
 206   }\r
 207 \r
 208   /**\r
 209    * DOCUMENT ME!\r
 210    *\r
 211    * @param result DOCUMENT ME!\r
 212    * @param out DOCUMENT ME!\r
 213    * @param align DOCUMENT ME!\r
 214    */\r
 215   void ReadUniprotFile(File file, Vector ids)\r
 216   {\r
 217     if(!file.exists())\r
 218       return;\r
 219 \r
 220     SequenceI sequence = null;\r
 221 \r
 222     Vector entries = getUniprotEntries(file);\r
 223 \r
 224     int i, iSize = entries==null?0:entries.size();\r
 225     UniprotEntry entry;\r
 226     for (i = 0; i < iSize; i++)\r
 227     {\r
 228       entry = (UniprotEntry) entries.elementAt(i);\r
 229       String idmatch = entry.getAccession().elementAt(0).toString();\r
 230       sequence = dataset.findName(idmatch);\r
 231 \r
 232       if (sequence == null)\r
 233       {\r
 234         //Sequence maybe Name, not Accession\r
 235         idmatch = entry.getName().elementAt(0).toString();\r
 236         sequence = dataset.findName(idmatch);\r
 237       }\r
 238 \r
 239       if(sequence!=null)\r
 240         ids.remove(sequence.getName());\r
 241 \r
 242       else  if (sequence == null && uniprotFlag)\r
 243       {\r
 244           sequence = dataset.findName("UniProt/Swiss-Prot|"+entry.getAccession().elementAt(0)+"|"+idmatch);\r
 245           ids.remove(idmatch);\r
 246       }\r
 247 \r
 248       if(sequence ==null)\r
 249       {\r
 250         System.out.println(idmatch+" not found");\r
 251         continue;\r
 252       }\r
 253 \r
 254 \r
 255       String nonGapped = AlignSeq.extractGaps("-. ", sequence.getSequence());\r
 256 \r
 257       int absStart = entry.getUniprotSequence().getContent().indexOf(\r
 258           nonGapped.toString());\r
 259 \r
 260       if (absStart == -1)\r
 261       {\r
 262         // Is UniprotSequence contained in dataset sequence?\r
 263         absStart = nonGapped.toString().indexOf(entry.getUniprotSequence().getContent());\r
 264         if(absStart == -1)\r
 265         {\r
 266           sbuffer.append(sequence.getName() +\r
 267                          " SEQUENCE NOT %100 MATCH \n");\r
 268 \r
 269           continue;\r
 270         }\r
 271         else\r
 272         {\r
 273 \r
 274           if(entry.getFeature()!=null)\r
 275           {\r
 276             Enumeration e = entry.getFeature().elements();\r
 277             while (e.hasMoreElements())\r
 278             {\r
 279               SequenceFeature sf = (SequenceFeature) e.nextElement();\r
 280               sf.setBegin(sf.getBegin() + absStart + 1);\r
 281               sf.setEnd(sf.getEnd() + absStart + 1);\r
 282             }\r
 283           }\r
 284 \r
 285           sbuffer.append(sequence.getName() +\r
 286                          " HAS "+absStart+" PREFIXED RESIDUES COMPARED TO UNIPROT - ANY SEQUENCE FEATURES"\r
 287                         +" HAVE BEEN ADJUSTED ACCORDINGLY \n");\r
 288           absStart = 0;\r
 289         }\r
 290 \r
 291       }\r
 292 \r
 293       unknownSequences.remove(sequence);\r
 294 \r
 295       int absEnd = absStart + nonGapped.toString().length();\r
 296       absStart += 1;\r
 297 \r
 298       Enumeration e = entry.getDbReference().elements();\r
 299       Vector onlyPdbEntries = new Vector();\r
 300       while(e.hasMoreElements())\r
 301       {\r
 302         PDBEntry pdb = (PDBEntry)e.nextElement();\r
 303         if(!pdb.getType().equals("PDB"))\r
 304           continue;\r
 305 \r
 306         onlyPdbEntries.addElement(pdb);\r
 307       }\r
 308 \r
 309       sequence.setPDBId(onlyPdbEntries);\r
 310       if (entry.getFeature()!=null) {\r
 311         e = entry.getFeature().elements();\r
 312         while (e.hasMoreElements())\r
 313         {\r
 314           sequence.addSequenceFeature( (SequenceFeature) e.nextElement());\r
 315         }\r
 316       }\r
 317       sequence.setStart(absStart);\r
 318       sequence.setEnd(absEnd);\r
 319 \r
 320 \r
 321       int n = 0;\r
 322       SequenceI seq2;\r
 323       while (n < align.getHeight())\r
 324       {\r
 325         //This loop enables multiple sequences with the same\r
 326         //id to have features added and seq limits updated\r
 327         seq2 = align.getSequenceAt(n);\r
 328         if (seq2.getName().equals(idmatch))\r
 329         {\r
 330 \r
 331           nonGapped = AlignSeq.extractGaps("-. ", seq2.getSequence());\r
 332 \r
 333           absStart = sequence.getSequence().indexOf(nonGapped);\r
 334           absEnd = absStart + nonGapped.toString().length() - 1;\r
 335 \r
 336           // This is the Viewd alignment sequences\r
 337           // No need to tell the user of the dataset updates\r
 338           if ( (seq2.getStart() != absStart+sequence.getStart())\r
 339              || (seq2.getEnd() != absEnd+sequence.getStart()))\r
 340           {\r
 341             sbuffer.append("Updated: " + seq2.getName() + " " +\r
 342                            seq2.getStart() + "/" + seq2.getEnd() +\r
 343                            "  to  " + (absStart + sequence.getStart()) + "/" +\r
 344                            (absEnd + sequence.getStart()) + "\n");\r
 345 \r
 346             seq2.setStart(absStart + sequence.getStart());\r
 347             seq2.setEnd(absEnd + sequence.getStart());\r
 348           }\r
 349         }\r
 350 \r
 351         n++;\r
 352       }\r
 353     }\r
 354   }\r
 355 }\r
 356 \r
 357 \r