test/jalview/ws/SequenceFetcherTest.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;
  22
  23 import jalview.analysis.CrossRef;
  24 import jalview.datamodel.Alignment;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.DBRefSource;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.ws.seqfetcher.ASequenceFetcher;
  29 import jalview.ws.seqfetcher.DbSourceProxy;
  30
  31 import java.util.Enumeration;
  32 import java.util.List;
  33 import java.util.Vector;
  34
  35 public class SequenceFetcherTest
  36 {
  37
  38   /**
  39    * simple run method to test dbsources.
  40    *
  41    * @param argv
  42    */
  43   public static void main(String[] argv)
  44   {
  45     // TODO: extracted from SequenceFetcher - convert to proper unit test with
  46     // assertions
  47
  48     String usage = "SequenceFetcher.main [-nodas] [<DBNAME> [<ACCNO>]]\n"
  49             + "With no arguments, all DbSources will be queried with their test Accession number.\n"
  50             + "With one argument, the argument will be resolved to one or more db sources and each will be queried with their test accession only.\n"
  51             + "If given two arguments, SequenceFetcher will try to find the DbFetcher corresponding to <DBNAME> and retrieve <ACCNO> from it.\n"
  52             + "The -nodas option will exclude DAS sources from the database fetchers Jalview will try to use.";
  53     boolean withDas = true;
  54     if (argv != null && argv.length > 0
  55             && argv[0].toLowerCase().startsWith("-nodas"))
  56     {
  57       withDas = false;
  58       String targs[] = new String[argv.length - 1];
  59       System.arraycopy(argv, 1, targs, 0, targs.length);
  60       argv = targs;
  61     }
  62     if (argv != null && argv.length > 0)
  63     {
  64       List<DbSourceProxy> sps = new SequenceFetcher(withDas)
  65               .getSourceProxy(argv[0]);
  66
  67       if (sps != null)
  68       {
  69         for (DbSourceProxy sp : sps)
  70         {
  71           AlignmentI al = null;
  72           try
  73           {
  74             testRetrieval(argv[0], sp,
  75                     argv.length > 1 ? argv[1] : sp.getTestQuery());
  76           } catch (Exception e)
  77           {
  78             e.printStackTrace();
  79             System.err.println("Error when retrieving "
  80                     + (argv.length > 1 ? argv[1] : sp.getTestQuery())
  81                     + " from " + argv[0] + "\nUsage: " + usage);
  82           }
  83         }
  84         return;
  85       }
  86       else
  87       {
  88         System.err.println("Can't resolve " + argv[0]
  89                 + " as a database name. Allowed values are :\n"
  90                 + new SequenceFetcher().getSupportedDb());
  91       }
  92       System.out.println(usage);
  93       return;
  94     }
  95     ASequenceFetcher sfetcher = new SequenceFetcher(withDas);
  96     String[] dbSources = sfetcher.getSupportedDb();
  97     for (int dbsource = 0; dbsource < dbSources.length; dbsource++)
  98     {
  99       String db = dbSources[dbsource];
 100       // skip me
 101       if (db.equals(DBRefSource.PDB))
 102       {
 103         continue;
 104       }
 105       for (DbSourceProxy sp : sfetcher.getSourceProxy(db))
 106       {
 107         testRetrieval(db, sp, sp.getTestQuery());
 108       }
 109     }
 110
 111   }
 112
 113   private static void testRetrieval(String db, DbSourceProxy sp,
 114           String testQuery)
 115   {
 116     AlignmentI ds = null;
 117     Vector<Object[]> noProds = new Vector<Object[]>();
 118     System.out.println("Source: " + sp.getDbName() + " (" + db
 119             + "): retrieving test:" + sp.getTestQuery());
 120     {
 121       AlignmentI al = null;
 122       try
 123       {
 124         al = sp.getSequenceRecords(testQuery);
 125         if (al != null && al.getHeight() > 0)
 126         {
 127           boolean dna = sp.isDnaCoding();
 128           al.setDataset(null);
 129           AlignmentI alds = al.getDataset();
 130           // try and find products
 131           CrossRef crossRef = new CrossRef(al.getSequencesArray(), alds);
 132           List<String> types = crossRef.findXrefSourcesForSequences(dna);
 133           if (types != null)
 134           {
 135             System.out.println("Xref Types for: " + (dna ? "dna" : "prot"));
 136             for (String source : types)
 137             {
 138               System.out.println("Type: " + source);
 139               SequenceI[] prod = crossRef.findXrefSequences(source, dna)
 140                       .getSequencesArray();
 141               System.out.println("Found "
 142                       + ((prod == null) ? "no" : "" + prod.length)
 143                       + " products");
 144               if (prod != null)
 145               {
 146                 for (int p = 0; p < prod.length; p++)
 147                 {
 148                   System.out.println("Prod " + p + ": "
 149                           + prod[p].getDisplayId(true));
 150                 }
 151               }
 152             }
 153           }
 154           else
 155           {
 156             noProds.addElement((dna ? new Object[] { al, al }
 157                     : new Object[] { al }));
 158           }
 159
 160         }
 161       } catch (Exception ex)
 162       {
 163         System.out.println("ERROR:Failed to retrieve test query.");
 164         ex.printStackTrace(System.out);
 165       }
 166
 167       if (al == null)
 168       {
 169         System.out.println("ERROR:No alignment retrieved.");
 170         StringBuffer raw = sp.getRawRecords();
 171         if (raw != null)
 172         {
 173           System.out.println(raw.toString());
 174         }
 175         else
 176         {
 177           System.out.println("ERROR:No Raw results.");
 178         }
 179       }
 180       else
 181       {
 182         System.out.println("Retrieved " + al.getHeight() + " sequences.");
 183         if (ds == null)
 184         {
 185           ds = al.getDataset();
 186         }
 187         else
 188         {
 189           ds.append(al.getDataset());
 190           al.setDataset(ds);
 191         }
 192       }
 193       System.out.flush();
 194       System.err.flush();
 195     }
 196     if (noProds.size() > 0)
 197     {
 198       Enumeration<Object[]> ts = noProds.elements();
 199       while (ts.hasMoreElements())
 200
 201       {
 202         Object[] typeSq = ts.nextElement();
 203         boolean dna = (typeSq.length > 1);
 204         AlignmentI al = (AlignmentI) typeSq[0];
 205         System.out.println("Trying getProducts for "
 206                 + al.getSequenceAt(0).getDisplayId(true));
 207         System.out.println("Search DS Xref for: " + (dna ? "dna" : "prot"));
 208         // have a bash at finding the products amongst all the retrieved
 209         // sequences.
 210         SequenceI[] seqs = al.getSequencesArray();
 211         Alignment prodal = new CrossRef(seqs, ds).findXrefSequences(null,
 212                 dna);
 213         System.out.println("Found "
 214                 + ((prodal == null) ? "no" : "" + prodal.getHeight())
 215                 + " products");
 216         if (prodal != null)
 217         {
 218           SequenceI[] prod = prodal.getSequencesArray(); // note
 219           // should
 220           // test
 221           // rather
 222           // than
 223           // throw
 224           // away
 225           // codon
 226           // mapping
 227           // (if
 228           // present)
 229           for (int p = 0; p < prod.length; p++)
 230           {
 231             System.out.println("Prod " + p + ": "
 232                     + prod[p].getDisplayId(true));
 233           }
 234         }
 235       }
 236     }
 237   }
 238 }