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