src/jalview/ws/dbsources/das/datamodel/DasSequenceSource.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This file is part of Jalview.\r
   6  * \r
   7  * Jalview is free software: you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License \r
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10  * \r
  11  * Jalview is distributed in the hope that it will be useful, but \r
  12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14  * PURPOSE.  See the GNU General Public License for more details.\r
  15  * \r
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17  */\r
  18 package jalview.ws.dbsources.das.datamodel;\r
  19 \r
  20 import java.util.ArrayList;\r
  21 import java.util.HashMap;\r
  22 import java.util.List;\r
  23 import java.util.Map;\r
  24 import java.util.StringTokenizer;\r
  25 import java.util.Vector;\r
  26 \r
  27 import org.biodas.jdas.client.adapters.sequence.DasSequenceAdapter;\r
  28 import org.biodas.jdas.client.threads.SequenceClientMultipleSources;\r
  29 import org.biodas.jdas.schema.sequence.SEQUENCE;\r
  30 import org.biodas.jdas.schema.sources.COORDINATES;\r
  31 import org.biodas.jdas.schema.sources.SOURCE;\r
  32 import org.biodas.jdas.schema.sources.VERSION;\r
  33 \r
  34 import com.stevesoft.pat.Regex;\r
  35 \r
  36 import jalview.ws.dbsources.das.api.jalviewSourceI;\r
  37 import jalview.ws.seqfetcher.*;\r
  38 import jalview.bin.Cache;\r
  39 import jalview.datamodel.Alignment;\r
  40 import jalview.datamodel.AlignmentI;\r
  41 import jalview.datamodel.DBRefEntry;\r
  42 import jalview.datamodel.Sequence;\r
  43 import jalview.datamodel.SequenceI;\r
  44 \r
  45 /**\r
  46  * an instance of this class is created for each unique DAS Sequence source (ie\r
  47  * one capable of handling the 'sequence' for a particular MapMaster)\r
  48  * \r
  49  * @author JimP\r
  50  * \r
  51  */\r
  52 public class DasSequenceSource extends DbSourceProxyImpl implements\r
  53         DbSourceProxy\r
  54 {\r
  55   private jalviewSourceI jsrc;\r
  56 \r
  57   protected SOURCE source = null;\r
  58 \r
  59   protected VERSION version = null;\r
  60 \r
  61   protected COORDINATES coordsys = null;\r
  62 \r
  63   protected String dbname = "DASCS";\r
  64 \r
  65   protected String dbrefname = "das:source";\r
  66 \r
  67   /**\r
  68    * create a new DbSource proxy for a DAS 1 source\r
  69    * \r
  70    * @param dbnbame\r
  71    *          Human Readable Name to use when fetching from this source\r
  72    * @param dbrefname\r
  73    *          DbRefName for DbRefs attached to sequences retrieved from this\r
  74    *          source\r
  75    * @param source\r
  76    *          Das1Source\r
  77    * @param coordsys\r
  78    *          specific coordinate system to use for this source\r
  79    * @throws Exception\r
  80    *           if source is not capable of the 'sequence' command\r
  81    */\r
  82   public DasSequenceSource(String dbname, String dbrefname, SOURCE source,\r
  83           VERSION version, COORDINATES coordsys) throws Exception\r
  84   {\r
  85     if (!(jsrc = new JalviewSource(source, false)).isSequenceSource())\r
  86     {\r
  87       throw new Exception("Source " + source.getTitle()\r
  88               + " does not support the sequence command.");\r
  89     }\r
  90     this.source = source;\r
  91     this.dbname = dbname;\r
  92     this.dbrefname = dbrefname;\r
  93     this.coordsys = coordsys;\r
  94   }\r
  95 \r
  96   public String getAccessionSeparator()\r
  97   {\r
  98     return "\t";\r
  99   }\r
 100 \r
 101   public Regex getAccessionValidator()\r
 102   {\r
 103     /** ? * */\r
 104     return Regex.perlCode("\\S+");\r
 105   }\r
 106 \r
 107   public String getDbName()\r
 108   {\r
 109     // TODO: map to\r
 110     return dbname + " (DAS)";\r
 111   }\r
 112 \r
 113   public String getDbSource()\r
 114   {\r
 115     return dbrefname;\r
 116   }\r
 117 \r
 118   public String getDbVersion()\r
 119   {\r
 120     return coordsys.getVersion();\r
 121   }\r
 122 \r
 123 \r
 124   public AlignmentI getSequenceRecords(String queries) throws Exception\r
 125   {\r
 126     StringTokenizer st = new StringTokenizer(queries, "\t");\r
 127     List<String> toks = new ArrayList<String>(), src = new ArrayList<String>();\r
 128     while (st.hasMoreTokens())\r
 129     {\r
 130       toks.add(st.nextToken());\r
 131     }\r
 132     src.add(jsrc.getSourceURL());\r
 133     Map<String, Map<List<String>, DasSequenceAdapter>> resultset = new HashMap<String, Map<List<String>, DasSequenceAdapter>>();\r
 134     Map<String, Map<List<String>, Exception>> errors = new HashMap<String, Map<List<String>, Exception>>();\r
 135     SequenceClientMultipleSources sclient;\r
 136     sclient = new SequenceClientMultipleSources();\r
 137     sclient.fetchData(src, toks, resultset, errors);\r
 138     sclient.shutDown();\r
 139     while (!sclient.isTerminated())\r
 140     {\r
 141       try {Thread.sleep(200);\r
 142       \r
 143       } catch (InterruptedException x) {}\r
 144     }\r
 145             \r
 146     if (resultset.isEmpty())\r
 147     {\r
 148       System.err.println("Sequence Query to " + jsrc.getTitle() + " with '"\r
 149               + queries + "' returned no sequences.");\r
 150       return null;\r
 151     }\r
 152     else\r
 153     {\r
 154       Vector<SequenceI> seqs=null;\r
 155       for (Map.Entry<String, Map<List<String>, DasSequenceAdapter>> resset : resultset\r
 156               .entrySet())\r
 157       {\r
 158         for (Map.Entry<List<String>, DasSequenceAdapter> result : resset\r
 159                 .getValue().entrySet())\r
 160         {\r
 161           DasSequenceAdapter dasseqresp = result.getValue();\r
 162           List<String> accessions = result.getKey();\r
 163           for (SEQUENCE e : dasseqresp.getSequence())\r
 164           {\r
 165             String lbl = e.getId();\r
 166 \r
 167             if (toks.indexOf(lbl) == -1)\r
 168             {\r
 169               System.err\r
 170                       .println("Warning - received sequence event for strange accession code ("\r
 171                               + lbl + ")");\r
 172             }\r
 173             else\r
 174             {\r
 175               if (seqs == null)\r
 176               {\r
 177                 if (e.getContent().length() == 0)\r
 178                 {\r
 179                   System.err\r
 180                           .println("Empty sequence returned for accession code ("\r
 181                                   + lbl\r
 182                                   + ") from "\r
 183                                   + resset.getKey()\r
 184                                   + " (source is "\r
 185                                   + getDbName());\r
 186                   continue;\r
 187                 }\r
 188               }\r
 189               seqs = new java.util.Vector<SequenceI>();\r
 190               // JDAS returns a sequence complete with any newlines and spaces in the XML\r
 191               Sequence sq = new Sequence(lbl, e.getContent().replaceAll("\\s+", ""));\r
 192               sq.addDBRef(new DBRefEntry(getDbSource(), getDbVersion()\r
 193                       + ":" + e.getVersion(), lbl));\r
 194               seqs.addElement(sq);\r
 195             }\r
 196           }\r
 197         }\r
 198       }\r
 199 \r
 200       if (seqs == null || seqs.size() == 0)\r
 201         return null;\r
 202       SequenceI[] sqs = new SequenceI[seqs.size()];\r
 203       for (int i = 0, iSize = seqs.size(); i < iSize; i++)\r
 204       {\r
 205         sqs[i] = (SequenceI) seqs.elementAt(i);\r
 206       }\r
 207       Alignment al = new Alignment(sqs);\r
 208       if (jsrc.isFeatureSource())\r
 209       {\r
 210         java.util.Vector<jalviewSourceI> srcs = new java.util.Vector<jalviewSourceI>();\r
 211         srcs.addElement(jsrc);\r
 212         try {\r
 213           new jalview.ws.DasSequenceFeatureFetcher(sqs, null, srcs, false,\r
 214                 false);\r
 215         } catch (Exception x)\r
 216         {\r
 217           Cache.log.error("Couldn't retrieve features for sequence from its source.",x);\r
 218         }\r
 219       }\r
 220 \r
 221       return al;\r
 222     }\r
 223   }\r
 224 \r
 225   public String getTestQuery()\r
 226   {\r
 227     return coordsys.getTestRange();\r
 228   }\r
 229 \r
 230   public boolean isValidReference(String accession)\r
 231   {\r
 232     // TODO try to validate an accession against source\r
 233     // We don't really know how to do this without querying source\r
 234 \r
 235     return true;\r
 236   }\r
 237 \r
 238   /**\r
 239    * @return the source\r
 240    */\r
 241   public SOURCE getSource()\r
 242   {\r
 243     return source;\r
 244   }\r
 245 \r
 246   /**\r
 247    * @return the coordsys\r
 248    */\r
 249   public COORDINATES getCoordsys()\r
 250   {\r
 251     return coordsys;\r
 252   }\r
 253 }\r