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