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 \r
  52   public SequenceFeatureFetcher()\r
  53   {}\r
  54 \r
  55   public Vector getUniprotEntries(File file)\r
  56   {\r
  57 \r
  58     UniprotFile uni = new UniprotFile();\r
  59     try\r
  60     {\r
  61       // 1. Load the mapping information from the file\r
  62       Mapping map = new Mapping(uni.getClass().getClassLoader());\r
  63       java.net.URL url = getClass().getResource("/uniprot_mapping.xml");\r
  64       map.loadMapping(url);\r
  65 \r
  66       // 2. Unmarshal the data\r
  67       Unmarshaller unmar = new Unmarshaller();\r
  68       unmar.setIgnoreExtraElements(true);\r
  69       unmar.setMapping(map);\r
  70       uni = (UniprotFile) unmar.unmarshal(new FileReader(file));\r
  71 \r
  72     }\r
  73     catch (Exception e)\r
  74     {\r
  75       System.out.println("Error getUniprotEntries() "+e);\r
  76     }\r
  77     return uni.getUniprotEntries();\r
  78   }\r
  79 \r
  80   /**\r
  81    * Creates a new SequenceFeatureFetcher object.\r
  82    *\r
  83    * @param align DOCUMENT ME!\r
  84    * @param ap DOCUMENT ME!\r
  85    */\r
  86   public SequenceFeatureFetcher(AlignmentI align, AlignmentPanel ap)\r
  87   {\r
  88     unknownSequences = new ArrayList();\r
  89     this.align = align;\r
  90     this.dataset = align.getDataset();\r
  91     this.ap = ap;\r
  92 \r
  93     Thread thread = new Thread(this);\r
  94     thread.start();\r
  95   }\r
  96 \r
  97   /**\r
  98    * DOCUMENT ME!\r
  99    */\r
 100   public void run()\r
 101   {\r
 102     try\r
 103     {\r
 104       int seqIndex = 0;\r
 105       Vector sequences = dataset.getSequences();\r
 106 \r
 107       while (seqIndex < sequences.size())\r
 108       {\r
 109         Vector ids = new Vector();\r
 110 \r
 111         for (int i = 0; (seqIndex < sequences.size()) && (i < 50);\r
 112              seqIndex++, i++)\r
 113         {\r
 114           SequenceI sequence = (SequenceI) sequences.get(seqIndex);\r
 115           if(!ids.contains(sequence.getName()))\r
 116           {\r
 117             ids.add(sequence.getName());\r
 118             unknownSequences.add(sequence);\r
 119           }\r
 120         }\r
 121 \r
 122         ///////////////////////////////////\r
 123         ///READ FROM EBI\r
 124         if (ids.size() > 0)\r
 125         {\r
 126           StringBuffer remainingIds = new StringBuffer("uniprot:");\r
 127           for (int i = 0; i < ids.size(); i++)\r
 128            {\r
 129              remainingIds.append(ids.get(i) + ";");\r
 130            }\r
 131           EBIFetchClient ebi = new EBIFetchClient();\r
 132           File file = ebi.fetchDataAsFile(remainingIds.toString(),\r
 133                                           "xml", "raw");\r
 134 \r
 135 \r
 136 \r
 137           if (file != null)\r
 138           {\r
 139             ReadUniprotFile(file, ids);\r
 140           }\r
 141         }\r
 142       }\r
 143     }\r
 144     catch (Exception ex)\r
 145     {\r
 146       ex.printStackTrace();\r
 147     }\r
 148 \r
 149     if (sbuffer.length() > 0)\r
 150     {\r
 151       output.setText(\r
 152           "Your sequences have been matched to Uniprot. Some of the ids have been\n" +\r
 153           "altered, most likely the start/end residue will have been updated.\n" +\r
 154           "Save your alignment to maintain the updated id.\n\n" +\r
 155           sbuffer.toString());\r
 156       Desktop.addInternalFrame(output, "Sequence names updated ", 600, 300);\r
 157       // The above is the dataset, we must now find out the index\r
 158       // of the viewed sequence\r
 159 \r
 160     }\r
 161 \r
 162     promptBeforeBlast();\r
 163 \r
 164   }\r
 165 \r
 166 \r
 167   void promptBeforeBlast()\r
 168    {\r
 169      // This must be outside the run() body as java 1.5\r
 170      // will not return any value from the OptionPane to the expired thread.\r
 171       if (unknownSequences.size() > 0)\r
 172       {\r
 173         int reply = javax.swing.JOptionPane.showConfirmDialog(\r
 174             Desktop.desktop, "Couldn't find a match for "+unknownSequences.size()+" sequences."\r
 175                 +"\nPerform blast for unknown sequences?",\r
 176                     "Blast for Unidentified Sequences",\r
 177                      javax.swing.JOptionPane.YES_NO_OPTION, javax.swing.JOptionPane.QUESTION_MESSAGE);\r
 178 \r
 179         if(reply == javax.swing.JOptionPane.YES_OPTION)\r
 180          new WSWUBlastClient(ap, align, unknownSequences);\r
 181       }\r
 182 \r
 183 \r
 184     ap.repaint();\r
 185   }\r
 186 \r
 187   /**\r
 188    * DOCUMENT ME!\r
 189    *\r
 190    * @param result DOCUMENT ME!\r
 191    * @param out DOCUMENT ME!\r
 192    * @param align DOCUMENT ME!\r
 193    */\r
 194   void ReadUniprotFile(File file, Vector ids)\r
 195   {\r
 196     if(!file.exists())\r
 197       return;\r
 198 \r
 199     SequenceI sequence = null;\r
 200 \r
 201     Vector entries = getUniprotEntries(file);\r
 202 \r
 203     int i, iSize = entries==null?0:entries.size();\r
 204     UniprotEntry entry;\r
 205     for (i = 0; i < iSize; i++)\r
 206     {\r
 207       entry = (UniprotEntry) entries.elementAt(i);\r
 208       String idmatch = entry.getAccession().elementAt(0).toString();\r
 209       sequence = dataset.findName(idmatch);\r
 210 \r
 211       if (sequence == null)\r
 212       {\r
 213         //Sequence maybe Name, not Accession\r
 214         idmatch = entry.getName().elementAt(0).toString();\r
 215         sequence = dataset.findName(idmatch);\r
 216       }\r
 217 \r
 218       if (sequence == null)\r
 219       {\r
 220         System.out.println(idmatch+" not found");\r
 221         continue;\r
 222       }\r
 223 \r
 224       ids.remove(sequence.getName());\r
 225       unknownSequences.remove(sequence);\r
 226 \r
 227       String nonGapped = AlignSeq.extractGaps("-. ", sequence.getSequence());\r
 228 \r
 229       int absStart = entry.getUniprotSequence().getContent().indexOf(\r
 230           nonGapped.toString());\r
 231 \r
 232       if (absStart == -1)\r
 233       {\r
 234         // Is UniprotSequence contained in dataset sequence?\r
 235         absStart = nonGapped.toString().indexOf(entry.getUniprotSequence().getContent());\r
 236         if(absStart == -1)\r
 237         {\r
 238           unknownSequences.add(sequence.getName());\r
 239           sbuffer.append(sequence.getName() +\r
 240                          " SEQUENCE NOT %100 MATCH \n");\r
 241 \r
 242           continue;\r
 243         }\r
 244         else\r
 245         {\r
 246           if(entry.getFeature()!=null)\r
 247           {\r
 248             Enumeration e = entry.getFeature().elements();\r
 249             while (e.hasMoreElements())\r
 250             {\r
 251               SequenceFeature sf = (SequenceFeature) e.nextElement();\r
 252               sf.setBegin(sf.getBegin() + absStart + 1);\r
 253               sf.setEnd(sf.getEnd() + absStart + 1);\r
 254             }\r
 255           }\r
 256 \r
 257           sbuffer.append(sequence.getName() +\r
 258                          " HAS "+absStart+" PREFIXED RESIDUES COMPARED TO UNIPROT - ANY SEQUENCE FEATURES"\r
 259                         +" HAVE BEEN ADJUSTED ACCORDINGLY \n");\r
 260           absStart = 0;\r
 261         }\r
 262 \r
 263       }\r
 264 \r
 265       int absEnd = absStart + nonGapped.toString().length();\r
 266       absStart += 1;\r
 267 \r
 268       Enumeration e = entry.getDbReference().elements();\r
 269       Vector onlyPdbEntries = new Vector();\r
 270       while(e.hasMoreElements())\r
 271       {\r
 272         PDBEntry pdb = (PDBEntry)e.nextElement();\r
 273         if(!pdb.getType().equals("PDB"))\r
 274           continue;\r
 275 \r
 276         onlyPdbEntries.addElement(pdb);\r
 277       }\r
 278 \r
 279       sequence.setPDBId(onlyPdbEntries);\r
 280       sequence.setSequenceFeatures(entry.getFeature());\r
 281       sequence.setStart(absStart);\r
 282       sequence.setEnd(absEnd);\r
 283 \r
 284 \r
 285       int n = 0;\r
 286       SequenceI seq2;\r
 287       while (n < align.getHeight())\r
 288       {\r
 289         //This loop enables multiple sequences with the same\r
 290         //id to have features added and seq limits updated\r
 291         seq2 = align.getSequenceAt(n);\r
 292         if (seq2.getName().equals(idmatch))\r
 293         {\r
 294 \r
 295           nonGapped = AlignSeq.extractGaps("-. ", seq2.getSequence());\r
 296 \r
 297           absStart = sequence.getSequence().indexOf(nonGapped);\r
 298           absEnd = absStart + nonGapped.toString().length() - 1;\r
 299 \r
 300           // This is the Viewd alignment sequences\r
 301           // No need to tell the user of the dataset updates\r
 302           if ( (seq2.getStart() != absStart+sequence.getStart())\r
 303              || (seq2.getEnd() != absEnd+sequence.getStart()))\r
 304           {\r
 305             sbuffer.append("Updated: " + seq2.getName() + " " +\r
 306                            seq2.getStart() + "/" + seq2.getEnd() +\r
 307                            "  to  " + (absStart + sequence.getStart()) + "/" +\r
 308                            (absEnd + sequence.getStart()) + "\n");\r
 309 \r
 310             seq2.setStart(absStart + sequence.getStart());\r
 311             seq2.setEnd(absEnd + sequence.getStart());\r
 312           }\r
 313         }\r
 314 \r
 315         n++;\r
 316       }\r
 317     }\r
 318   }\r
 319 }\r
 320 \r
 321 \r