+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
+ * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ */
package jalview.ws;\r
\r
-import java.util.Enumeration;\r
-import java.util.Hashtable;\r
-import java.util.Vector;\r
-\r
import jalview.datamodel.Alignment;\r
import jalview.datamodel.AlignmentI;\r
import jalview.datamodel.DBRefSource;\r
import jalview.datamodel.SequenceI;\r
+import jalview.ws.dbsources.das.api.jalviewSourceI;\r
+import jalview.ws.seqfetcher.ASequenceFetcher;\r
+import jalview.ws.seqfetcher.DbSourceProxy;\r
+\r
+import java.util.ArrayList;\r
+import java.util.Enumeration;\r
+import java.util.List;\r
+import java.util.Vector;\r
\r
/**\r
- * prototype of abstract sequence retrieval interface\r
+ * This is the the concrete implementation of the sequence retrieval interface\r
+ * and abstract class in jalview.ws.seqfetcher. This implements the run-time\r
+ * discovery of sequence database clients, and provides a hardwired main for\r
+ * testing all registered handlers.\r
* \r
*/\r
public class SequenceFetcher extends ASequenceFetcher\r
*/\r
public SequenceFetcher()\r
{\r
- FETCHABLEDBS = new Hashtable();\r
- FETCHABLEDBS.put(DBRefSource.EMBL,\r
- new jalview.ws.dbsources.EmblSource());\r
- FETCHABLEDBS.put(DBRefSource.EMBLCDS,\r
- new jalview.ws.dbsources.EmblCdsSouce());\r
- FETCHABLEDBS.put(DBRefSource.UNIPROT,\r
- new jalview.ws.dbsources.Uniprot());\r
- FETCHABLEDBS.put(DBRefSource.UP_NAME,\r
- new jalview.ws.dbsources.Uniprot());\r
- FETCHABLEDBS.put(DBRefSource.PDB, new jalview.ws.dbsources.Pdb());\r
- FETCHABLEDBS.put(DBRefSource.PFAM, new jalview.ws.dbsources.Pfam());\r
- };\r
+ this(true);\r
+ }\r
+ public SequenceFetcher(boolean addDas)\r
+ {\r
+ addDBRefSourceImpl(jalview.ws.dbsources.EmblSource.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.EmblCdsSouce.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.Uniprot.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.UnprotName.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.Pdb.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.PfamFull.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.PfamSeed.class); // ensures Seed\r
+ // alignment is\r
+ // 'default' for\r
+ // PFAM\r
+ addDBRefSourceImpl(jalview.ws.dbsources.RfamFull.class);\r
+ addDBRefSourceImpl(jalview.ws.dbsources.RfamSeed.class);\r
+ if (addDas) {\r
+ registerDasSequenceSources();\r
+ }\r
+ }\r
+\r
+ /**\r
+ * return an ordered list of database sources where non-das database classes\r
+ * appear before das database classes\r
+ */\r
+ public String[] getOrderedSupportedSources()\r
+ {\r
+ String[] srcs = this.getSupportedDb();\r
+ ArrayList<String> dassrc = new ArrayList<String>(), nondas = new ArrayList<String>();\r
+ for (int i = 0; i < srcs.length; i++)\r
+ {\r
+ boolean das = false, skip = false;\r
+ String nm;\r
+ for (DbSourceProxy dbs : getSourceProxy(srcs[i]))\r
+ {\r
+ // Skip the alignment databases for the moment - they're not useful for\r
+ // verifying a single sequence against its reference source\r
+ if (dbs.isA(DBRefSource.ALIGNMENTDB))\r
+ {\r
+ skip = true;\r
+ }\r
+ else\r
+ {\r
+ nm = dbs.getDbName();\r
+ if (getSourceProxy(srcs[i]) instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)\r
+ {\r
+ if (nm.startsWith("das:"))\r
+ {\r
+ nm = nm.substring(4);\r
+ das = true;\r
+ }\r
+ break;\r
+ }\r
+ }\r
+ }\r
+ if (skip)\r
+ {\r
+ continue;\r
+ }\r
+ if (das)\r
+ {\r
+ dassrc.add(srcs[i]);\r
+ }\r
+ else\r
+ {\r
+ nondas.add(srcs[i]);\r
+ }\r
+ }\r
+ String[] tosort = nondas.toArray(new String[0]), sorted = nondas\r
+ .toArray(new String[0]);\r
+ for (int j = 0, jSize = sorted.length; j < jSize; j++)\r
+ {\r
+ tosort[j] = tosort[j].toLowerCase();\r
+ }\r
+ jalview.util.QuickSort.sort(tosort, sorted);\r
+ // construct array with all sources listed\r
+\r
+ srcs = new String[sorted.length + dassrc.size()];\r
+ int i = 0;\r
+ for (int j = sorted.length - 1; j >= 0; j--, i++)\r
+ {\r
+ srcs[i] = sorted[j];\r
+ sorted[j] = null;\r
+ }\r
+\r
+ sorted = dassrc.toArray(new String[0]);\r
+ tosort = dassrc.toArray(new String[0]);\r
+ for (int j = 0, jSize = sorted.length; j < jSize; j++)\r
+ {\r
+ tosort[j] = tosort[j].toLowerCase();\r
+ }\r
+ jalview.util.QuickSort.sort(tosort, sorted);\r
+ for (int j = sorted.length - 1; j >= 0; j--, i++)\r
+ {\r
+ srcs[i] = sorted[j];\r
+ }\r
+ return srcs;\r
+ }\r
+\r
+ /**\r
+ * return plaintext databse list suitable for using in a GUI element\r
+ */\r
+ public String[] _getOrderedSupportedSources()\r
+ {\r
+ String[] srcs = this.getSupportedDb();\r
+ ArrayList dassrc = new ArrayList(), nondas = new ArrayList();\r
+ for (int i = 0; i < srcs.length; i++)\r
+ {\r
+ for (DbSourceProxy dbs : getSourceProxy(srcs[i]))\r
+ {\r
+ String nm = dbs.getDbName();\r
+ if (getSourceProxy(srcs[i]) instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)\r
+ {\r
+ if (nm.startsWith("das:"))\r
+ {\r
+ nm = nm.substring(4);\r
+ }\r
+ dassrc.add(new String[]\r
+ { srcs[i], nm.toUpperCase() });\r
+ }\r
+ else\r
+ {\r
+ nondas.add(new String[]\r
+ { srcs[i], nm.toUpperCase() });\r
+ }\r
+ }\r
+ }\r
+ Object[] sorted = nondas.toArray();\r
+ String[] tosort = new String[sorted.length];\r
+ nondas.clear();\r
+ for (int j = 0; j < sorted.length; j++)\r
+ {\r
+ tosort[j] = ((String[]) sorted[j])[1];\r
+ }\r
+ jalview.util.QuickSort.sort(tosort, sorted);\r
+ int i = 0;\r
+ // construct array with all sources listed\r
+ srcs = new String[sorted.length + dassrc.size()];\r
+ for (int j = sorted.length - 1; j >= 0; j--, i++)\r
+ {\r
+ srcs[i] = ((String[]) sorted[j])[0];\r
+ sorted[j] = null;\r
+ }\r
\r
+ sorted = dassrc.toArray();\r
+ tosort = new String[sorted.length];\r
+ dassrc.clear();\r
+ for (int j = 0; j < sorted.length; j++)\r
+ {\r
+ tosort[j] = ((String[]) sorted[j])[1];\r
+ }\r
+ jalview.util.QuickSort.sort(tosort, sorted);\r
+ for (int j = sorted.length - 1; j >= 0; j--, i++)\r
+ {\r
+ srcs[i] = ((String[]) sorted[j])[0];\r
+ sorted[j] = null;\r
+ }\r
+ return srcs;\r
+ }\r
+\r
+ /**\r
+ * simple run method to test dbsources.\r
+ * \r
+ * @param argv\r
+ */\r
public static void main(String[] argv)\r
{\r
AlignmentI ds = null;\r
Vector noProds = new Vector();\r
+ String usage = "SequenceFetcher.main [-nodas] [<DBNAME> [<ACCNO>]]\n"\r
+ + "With no arguments, all DbSources will be queried with their test Accession number.\n"\r
+ + "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"\r
+ + "If given two arguments, SequenceFetcher will try to find the DbFetcher corresponding to <DBNAME> and retrieve <ACCNO> from it.\n"\r
+ + "The -nodas option will exclude DAS sources from the database fetchers Jalview will try to use.";\r
+ boolean withDas=true;\r
+ if (argv!=null && argv.length>0 && argv[0].toLowerCase().startsWith("-nodas"))\r
+ {\r
+ withDas=false;\r
+ String targs[] = new String[argv.length-1];\r
+ System.arraycopy(argv, 1, targs, 0, targs.length);\r
+ argv=targs;\r
+ }\r
if (argv != null && argv.length > 0)\r
{\r
- System.out\r
- .println("Ignoring arguments. Future Usage = dbname:query1;query2;...");\r
+ List<DbSourceProxy> sps = new SequenceFetcher(withDas)\r
+ .getSourceProxy(argv[0]);\r
+\r
+ if (sps != null)\r
+ {\r
+ for (DbSourceProxy sp : sps)\r
+ {\r
+ AlignmentI al = null;\r
+ try\r
+ {\r
+ al = sp.getSequenceRecords(argv.length>1 ? argv[1] : sp.getTestQuery());\r
+ } catch (Exception e)\r
+ {\r
+ e.printStackTrace();\r
+ System.err.println("Error when retrieving " + (argv.length>1 ? argv[1] : sp.getTestQuery())\r
+ + " from " + argv[0] + "\nUsage: " + usage);\r
+ }\r
+ SequenceI[] prod = al.getSequencesArray();\r
+ if (al != null)\r
+ {\r
+ for (int p = 0; p < prod.length; p++)\r
+ {\r
+ System.out.println("Prod " + p + ": "\r
+ + prod[p].getDisplayId(true) + " : "\r
+ + prod[p].getDescription());\r
+ }\r
+ }\r
+ }\r
+ return;\r
+ }\r
+ else\r
+ {\r
+ System.err.println("Can't resolve " + argv[0]\r
+ + " as a database name. Allowed values are :\n"\r
+ + new SequenceFetcher().getSupportedDb());\r
+ }\r
+ System.out.println(usage);\r
+ return;\r
}\r
- SequenceFetcher sfetcher = new SequenceFetcher();\r
- Enumeration e = sfetcher.FETCHABLEDBS.keys();\r
- while (e.hasMoreElements())\r
+ ASequenceFetcher sfetcher = new SequenceFetcher(withDas);\r
+ String[] dbSources = sfetcher.getSupportedDb();\r
+ for (int dbsource = 0; dbsource < dbSources.length; dbsource++)\r
{\r
- String db = (String) e.nextElement();\r
+ String db = dbSources[dbsource];\r
// skip me\r
if (db.equals(DBRefSource.PDB))\r
continue;\r
- DbSourceProxy sp = sfetcher.getSourceProxy(db);\r
- System.out\r
- .println("" + db + ": retrieving test:" + sp.getTestQuery());\r
- AlignmentI al = null;\r
- try\r
+ for (DbSourceProxy sp : sfetcher.getSourceProxy(db))\r
{\r
- al = sp.getSequenceRecords(sp.getTestQuery());\r
- if (al != null && al.getHeight() > 0)\r
+ System.out.println("Source: " + sp.getDbName() + " (" + db\r
+ + "): retrieving test:" + sp.getTestQuery());\r
+ AlignmentI al = null;\r
+ try\r
{\r
- boolean dna = sp.getDbSourceProperties().containsKey(\r
- DBRefSource.DNACODINGSEQDB)\r
- || sp.getDbSourceProperties().containsKey(\r
- DBRefSource.DNASEQDB)\r
- || sp.getDbSourceProperties().containsKey(\r
- DBRefSource.CODINGSEQDB);\r
- // try and find products\r
- String types[] = jalview.analysis.CrossRef.findSequenceXrefTypes(\r
- dna, al.getSequencesArray());\r
- if (types != null)\r
+ al = sp.getSequenceRecords(sp.getTestQuery());\r
+ if (al != null && al.getHeight() > 0\r
+ && sp.getDbSourceProperties() != null)\r
{\r
- System.out.println("Xref Types for: "+(dna ? "dna" : "prot"));\r
- for (int t = 0; t < types.length; t++)\r
+ boolean dna = sp.getDbSourceProperties().containsKey(\r
+ DBRefSource.DNACODINGSEQDB)\r
+ || sp.getDbSourceProperties().containsKey(\r
+ DBRefSource.DNASEQDB)\r
+ || sp.getDbSourceProperties().containsKey(\r
+ DBRefSource.CODINGSEQDB);\r
+ // try and find products\r
+ String types[] = jalview.analysis.CrossRef\r
+ .findSequenceXrefTypes(dna, al.getSequencesArray());\r
+ if (types != null)\r
{\r
- System.out.println("Type: " + types[t]);\r
- SequenceI[] prod = jalview.analysis.CrossRef.findXrefSequences(al\r
- .getSequencesArray(), dna, types[t]).getSequencesArray();\r
- System.out.println("Found "\r
- + ((prod == null) ? "no" : "" + prod.length)\r
- + " products");\r
- if (prod!=null)\r
+ System.out.println("Xref Types for: "\r
+ + (dna ? "dna" : "prot"));\r
+ for (int t = 0; t < types.length; t++)\r
{\r
- for (int p=0; p<prod.length; p++)\r
+ System.out.println("Type: " + types[t]);\r
+ SequenceI[] prod = jalview.analysis.CrossRef\r
+ .findXrefSequences(al.getSequencesArray(), dna,\r
+ types[t]).getSequencesArray();\r
+ System.out.println("Found "\r
+ + ((prod == null) ? "no" : "" + prod.length)\r
+ + " products");\r
+ if (prod != null)\r
{\r
- System.out.println("Prod "+p+": "+prod[p].getDisplayId(true));\r
+ for (int p = 0; p < prod.length; p++)\r
+ {\r
+ System.out.println("Prod " + p + ": "\r
+ + prod[p].getDisplayId(true));\r
+ }\r
}\r
}\r
}\r
- } else {\r
- noProds.addElement((dna ? new Object[] { al, al } : new Object[] { al }) ); \r
+ else\r
+ {\r
+ noProds.addElement((dna ? new Object[]\r
+ { al, al } : new Object[]\r
+ { al }));\r
+ }\r
+\r
}\r
+ } catch (Exception ex)\r
+ {\r
+ System.out.println("ERROR:Failed to retrieve test query.");\r
+ ex.printStackTrace(System.out);\r
+ }\r
\r
+ if (al == null)\r
+ {\r
+ System.out.println("ERROR:No alignment retrieved.");\r
+ StringBuffer raw = sp.getRawRecords();\r
+ if (raw != null)\r
+ System.out.println(raw.toString());\r
+ else\r
+ System.out.println("ERROR:No Raw results.");\r
}\r
- } catch (Exception ex)\r
- {\r
- System.out.println("ERROR:Failed to retrieve test query.");\r
- ex.printStackTrace(System.out);\r
- }\r
- if (al == null)\r
- {\r
- System.out.println("ERROR:No alignment retrieved.");\r
- StringBuffer raw = sp.getRawRecords();\r
- if (raw != null)\r
- System.out.println(raw.toString());\r
else\r
- System.out.println("ERROR:No Raw results.");\r
- }\r
- else\r
- {\r
- System.out.println("Retrieved " + al.getHeight() + " sequences.");\r
- for (int s = 0; s < al.getHeight(); s++)\r
{\r
- SequenceI sq = al.getSequenceAt(s);\r
- while (sq.getDatasetSequence() != null)\r
+ System.out.println("Retrieved " + al.getHeight() + " sequences.");\r
+ for (int s = 0; s < al.getHeight(); s++)\r
{\r
- sq = sq.getDatasetSequence();\r
+ SequenceI sq = al.getSequenceAt(s);\r
+ while (sq.getDatasetSequence() != null)\r
+ {\r
+ sq = sq.getDatasetSequence();\r
\r
- }\r
- if (ds == null)\r
- {\r
- ds = new Alignment(new SequenceI[]\r
- { sq });\r
+ }\r
+ if (ds == null)\r
+ {\r
+ ds = new Alignment(new SequenceI[]\r
+ { sq });\r
\r
+ }\r
+ else\r
+ {\r
+ ds.addSequence(sq);\r
+ }\r
}\r
- else\r
+ }\r
+ System.out.flush();\r
+ System.err.flush();\r
+\r
+ }\r
+ if (noProds.size() > 0)\r
+ {\r
+ Enumeration ts = noProds.elements();\r
+ while (ts.hasMoreElements())\r
+\r
+ {\r
+ Object[] typeSq = (Object[]) ts.nextElement();\r
+ boolean dna = (typeSq.length > 1);\r
+ AlignmentI al = (AlignmentI) typeSq[0];\r
+ System.out.println("Trying getProducts for "\r
+ + al.getSequenceAt(0).getDisplayId(true));\r
+ System.out.println("Search DS Xref for: "\r
+ + (dna ? "dna" : "prot"));\r
+ // have a bash at finding the products amongst all the retrieved\r
+ // sequences.\r
+ SequenceI[] seqs = al.getSequencesArray();\r
+ Alignment prodal = jalview.analysis.CrossRef.findXrefSequences(\r
+ seqs, dna, null, ds);\r
+ System.out.println("Found "\r
+ + ((prodal == null) ? "no" : "" + prodal.getHeight())\r
+ + " products");\r
+ if (prodal != null)\r
{\r
- ds.addSequence(sq);\r
+ SequenceI[] prod = prodal.getSequencesArray(); // note\r
+ // should\r
+ // test\r
+ // rather\r
+ // than\r
+ // throw\r
+ // away\r
+ // codon\r
+ // mapping\r
+ // (if\r
+ // present)\r
+ for (int p = 0; p < prod.length; p++)\r
+ {\r
+ System.out.println("Prod " + p + ": "\r
+ + prod[p].getDisplayId(true));\r
+ }\r
}\r
}\r
+\r
}\r
- System.out.flush();\r
- System.err.flush();\r
\r
}\r
- if (noProds.size()>0)\r
+ }\r
+\r
+ /**\r
+ * query the currently defined DAS source registry for sequence sources and\r
+ * add a DasSequenceSource instance for each source to the SequenceFetcher\r
+ * source list.\r
+ */\r
+ public void registerDasSequenceSources()\r
+ {\r
+ // TODO: define a context as a registry provider (either desktop,\r
+ // jalview.bin.cache, or something else).\r
+ for (jalviewSourceI source : jalview.bin.Cache.getDasSourceRegistry()\r
+ .getSources())\r
{\r
- Enumeration ts = noProds.elements();\r
- while (ts.hasMoreElements())\r
- \r
+ if (source.isSequenceSource())\r
{\r
- Object[] typeSq = (Object[]) ts.nextElement();\r
- boolean dna = (typeSq.length>1);\r
- AlignmentI al = (AlignmentI) typeSq[0];\r
- System.out.println("Trying getProducts for "+al.getSequenceAt(0).getDisplayId(true));\r
- System.out.println("Search DS Xref for: "+(dna ? "dna" : "prot"));\r
- // have a bash at finding the products amongst all the retrieved sequences.\r
- SequenceI[] prod = jalview.analysis.CrossRef.findXrefSequences(al\r
- .getSequencesArray(), dna, null, ds).getSequencesArray(); // note should test rather than throw away codon mapping (if present)\r
- System.out.println("Found "\r
- + ((prod == null) ? "no" : "" + prod.length)\r
- + " products");\r
- if (prod!=null)\r
+ List<DbSourceProxy> dassources = source.getSequenceSourceProxies();\r
+ for (DbSourceProxy seqsrc : dassources)\r
{\r
- for (int p=0; p<prod.length; p++)\r
- {\r
- System.out.println("Prod "+p+": "+prod[p].getDisplayId(true));\r
- }\r
+ addDbRefSourceImpl(seqsrc);\r
}\r
}\r
-\r
}\r
}\r
+\r
}\r
git://source.jalview.org / jalview.git / blobdiff