src/jalview/ws/SequenceFetcher.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.ext.ensembl.EnsemblCdna;
  24 import jalview.ext.ensembl.EnsemblCds;
  25 import jalview.ext.ensembl.EnsemblGenome;
  26 import jalview.ext.ensembl.EnsemblProtein;
  27 import jalview.ws.dbsources.EmblCdsSource;
  28 import jalview.ws.dbsources.EmblSource;
  29 import jalview.ws.dbsources.Pdb;
  30 import jalview.ws.dbsources.PfamFull;
  31 import jalview.ws.dbsources.PfamSeed;
  32 import jalview.ws.dbsources.RfamFull;
  33 import jalview.ws.dbsources.RfamSeed;
  34 import jalview.ws.dbsources.Uniprot;
  35 import jalview.ws.dbsources.UniprotName;
  36 import jalview.ws.dbsources.das.api.jalviewSourceI;
  37 import jalview.ws.seqfetcher.ASequenceFetcher;
  38 import jalview.ws.seqfetcher.DbSourceProxy;
  39
  40 import java.util.ArrayList;
  41 import java.util.List;
  42
  43 /**
  44  * This is the the concrete implementation of the sequence retrieval interface
  45  * and abstract class in jalview.ws.seqfetcher. This implements the run-time
  46  * discovery of sequence database clientss.
  47  *
  48  */
  49 public class SequenceFetcher extends ASequenceFetcher
  50 {
  51   /**
  52    * Thread safe construction of database proxies TODO: extend to a configurable
  53    * database plugin mechanism where classes are instantiated by reflection and
  54    * queried for their DbRefSource and version association.
  55    *
  56    */
  57   public SequenceFetcher()
  58   {
  59     this(true);
  60   }
  61
  62   public SequenceFetcher(boolean addDas)
  63   {
  64     addDBRefSourceImpl(EnsemblProtein.class);
  65     addDBRefSourceImpl(EnsemblCds.class);
  66     addDBRefSourceImpl(EnsemblGenome.class);
  67     addDBRefSourceImpl(EnsemblCdna.class);
  68     addDBRefSourceImpl(EmblSource.class);
  69     addDBRefSourceImpl(EmblCdsSource.class);
  70     addDBRefSourceImpl(Uniprot.class);
  71     addDBRefSourceImpl(UniprotName.class);
  72     addDBRefSourceImpl(Pdb.class);
  73     addDBRefSourceImpl(PfamFull.class);
  74     addDBRefSourceImpl(PfamSeed.class);
  75     // ensures Seed alignment is 'default' for PFAM
  76     addDBRefSourceImpl(RfamFull.class);
  77     addDBRefSourceImpl(RfamSeed.class);
  78     if (addDas)
  79     {
  80       registerDasSequenceSources();
  81     }
  82   }
  83
  84   /**
  85    * return an ordered list of database sources where non-das database classes
  86    * appear before das database classes
  87    */
  88   public String[] getOrderedSupportedSources()
  89   {
  90     String[] srcs = this.getSupportedDb();
  91     ArrayList<String> dassrc = new ArrayList<String>(), nondas = new ArrayList<String>();
  92     for (int i = 0; i < srcs.length; i++)
  93     {
  94       boolean das = false, skip = false;
  95       String nm;
  96       for (DbSourceProxy dbs : getSourceProxy(srcs[i]))
  97       {
  98         // Skip the alignment databases for the moment - they're not useful for
  99         // verifying a single sequence against its reference source
 100         if (dbs.isAlignmentSource())
 101         {
 102           skip = true;
 103         }
 104         else
 105         {
 106           nm = dbs.getDbName();
 107           if (getSourceProxy(srcs[i]) instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)
 108           {
 109             if (nm.startsWith("das:"))
 110             {
 111               nm = nm.substring(4);
 112               das = true;
 113             }
 114             break;
 115           }
 116         }
 117       }
 118       if (skip)
 119       {
 120         continue;
 121       }
 122       if (das)
 123       {
 124         dassrc.add(srcs[i]);
 125       }
 126       else
 127       {
 128         nondas.add(srcs[i]);
 129       }
 130     }
 131     String[] tosort = nondas.toArray(new String[0]), sorted = nondas
 132             .toArray(new String[0]);
 133     for (int j = 0, jSize = sorted.length; j < jSize; j++)
 134     {
 135       tosort[j] = tosort[j].toLowerCase();
 136     }
 137     jalview.util.QuickSort.sort(tosort, sorted);
 138     // construct array with all sources listed
 139
 140     srcs = new String[sorted.length + dassrc.size()];
 141     int i = 0;
 142     for (int j = sorted.length - 1; j >= 0; j--, i++)
 143     {
 144       srcs[i] = sorted[j];
 145       sorted[j] = null;
 146     }
 147
 148     sorted = dassrc.toArray(new String[0]);
 149     tosort = dassrc.toArray(new String[0]);
 150     for (int j = 0, jSize = sorted.length; j < jSize; j++)
 151     {
 152       tosort[j] = tosort[j].toLowerCase();
 153     }
 154     jalview.util.QuickSort.sort(tosort, sorted);
 155     for (int j = sorted.length - 1; j >= 0; j--, i++)
 156     {
 157       srcs[i] = sorted[j];
 158     }
 159     return srcs;
 160   }
 161
 162   /**
 163    * query the currently defined DAS source registry for sequence sources and
 164    * add a DasSequenceSource instance for each source to the SequenceFetcher
 165    * source list.
 166    */
 167   public void registerDasSequenceSources()
 168   {
 169     // TODO: define a context as a registry provider (either desktop,
 170     // jalview.bin.cache, or something else).
 171     for (jalviewSourceI source : jalview.bin.Cache.getDasSourceRegistry()
 172             .getSources())
 173     {
 174       if (source.isSequenceSource())
 175       {
 176         List<DbSourceProxy> dassources = source.getSequenceSourceProxies();
 177         for (DbSourceProxy seqsrc : dassources)
 178         {
 179           addDbRefSourceImpl(seqsrc);
 180         }
 181       }
 182     }
 183   }
 184
 185 }