src/jalview/ws/dbsources/EmblXmlSource.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.ws.dbsources;
  22
  23 import jalview.datamodel.Alignment;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.datamodel.xdb.embl.EmblEntry;
  27 import jalview.datamodel.xdb.embl.EmblFile;
  28 import jalview.util.MessageManager;
  29 import jalview.ws.ebi.EBIFetchClient;
  30
  31 import java.io.File;
  32
  33 public abstract class EmblXmlSource extends EbiFileRetrievedProxy
  34 {
  35
  36   /**
  37    * Last properly parsed embl file.
  38    */
  39   public EmblFile efile = null;
  40
  41   public EmblXmlSource()
  42   {
  43     super();
  44   }
  45
  46   /**
  47    * retrieve and parse an emblxml file
  48    *
  49    * @param emprefx
  50    *          either EMBL or EMBLCDS strings are allowed - anything else will
  51    *          not retrieve emblxml
  52    * @param query
  53    * @return
  54    * @throws Exception
  55    */
  56   public AlignmentI getEmblSequenceRecords(String emprefx, String query)
  57           throws Exception
  58   {
  59     startQuery();
  60     EBIFetchClient dbFetch = new EBIFetchClient();
  61     File reply;
  62     try
  63     {
  64       reply = dbFetch.fetchDataAsFile(
  65               emprefx.toLowerCase() + ":" + query.trim(), "emblxml", null,
  66               ".xml");
  67     } catch (Exception e)
  68     {
  69       stopQuery();
  70       throw new Exception(MessageManager.formatMessage(
  71               "exception.ebiembl_retrieval_failed_on", new String[] {
  72                   emprefx.toLowerCase(), query.trim() }), e);
  73     }
  74     return getEmblSequenceRecords(emprefx, query, reply);
  75   }
  76
  77   /**
  78    * parse an emblxml file stored locally
  79    *
  80    * @param emprefx
  81    *          either EMBL or EMBLCDS strings are allowed - anything else will
  82    *          not retrieve emblxml
  83    * @param query
  84    * @param file
  85    *          the EMBL XML file containing the results of a query
  86    * @return
  87    * @throws Exception
  88    */
  89   public AlignmentI getEmblSequenceRecords(String emprefx, String query,
  90           File reply) throws Exception
  91   {
  92     SequenceI seqs[] = null;
  93     StringBuffer result = new StringBuffer();
  94     if (reply != null && reply.exists())
  95     {
  96       efile = null;
  97       file = reply.getAbsolutePath();
  98       if (reply.length() > 25)
  99       {
 100         efile = EmblFile.getEmblFile(reply);
 101       }
 102       else
 103       {
 104         result.append(MessageManager.formatMessage(
 105                 "label.no_embl_record_found",
 106                 new String[] { emprefx.toLowerCase(), query.trim() }));
 107       }
 108     }
 109     if (efile != null)
 110     {
 111       for (EmblEntry entry : efile.getEntries())
 112       {
 113         SequenceI[] seqparts = entry.getSequences(false, true, emprefx);
 114         // TODO: use !fetchNa,!fetchPeptide here instead - see todo in EmblEntry
 115         if (seqparts != null)
 116         {
 117           SequenceI[] newseqs = null;
 118           int si = 0;
 119           if (seqs == null)
 120           {
 121             newseqs = new SequenceI[seqparts.length];
 122           }
 123           else
 124           {
 125             newseqs = new SequenceI[seqs.length + seqparts.length];
 126
 127             for (; si < seqs.length; si++)
 128             {
 129               newseqs[si] = seqs[si];
 130               seqs[si] = null;
 131             }
 132           }
 133           for (int j = 0; j < seqparts.length; si++, j++)
 134           {
 135             newseqs[si] = seqparts[j].deriveSequence();
 136             // place DBReferences on dataset and refer
 137           }
 138           seqs = newseqs;
 139
 140         }
 141       }
 142     }
 143     else
 144     {
 145       result = null;
 146     }
 147     AlignmentI al = null;
 148     if (seqs != null && seqs.length > 0)
 149     {
 150       al = new Alignment(seqs);
 151       result.append(MessageManager.formatMessage(
 152               "label.embl_successfully_parsed", new String[] { emprefx }));
 153       results = result;
 154     }
 155     stopQuery();
 156     return al;
 157   }
 158
 159   @Override
 160   public boolean isDnaCoding()
 161   {
 162     return true;
 163   }
 164
 165 }