From: Jim Procter Date: Sun, 28 Jun 2015 16:19:40 +0000 (+0100) Subject: JAL-1705 javadoc to clarify requirements for regex validation for sources capable... X-Git-Tag: Release_2_10_0~296^2~90^2~8 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=0f4b2e6fc81dd2041c545190a664a3953ac774d2;p=jalview.git JAL-1705 javadoc to clarify requirements for regex validation for sources capable of multiple accession retrieval --- diff --git a/src/jalview/ws/seqfetcher/DbSourceProxy.java b/src/jalview/ws/seqfetcher/DbSourceProxy.java index 556df1f..33f62b6 100644 --- a/src/jalview/ws/seqfetcher/DbSourceProxy.java +++ b/src/jalview/ws/seqfetcher/DbSourceProxy.java @@ -94,7 +94,9 @@ public interface DbSourceProxy public String getTestQuery(); /** - * optionally implemented + * Required for sources supporting multiple query retrieval for use with the + * DBRefFetcher, which attempts to limit its queries with putative accession + * strings for a source to only those that are likely to be valid. * * @param accession * @return @@ -107,7 +109,9 @@ public interface DbSourceProxy * * @param queries * - one or more queries for database in expected form - * @return null if queries were successful but result was not parsable + * @return null if queries were successful but result was not parsable. + * Otherwise, an AlignmentI object containing properly annotated data + * (e.g. sequences with accessions for this datasource) * @throws Exception * - propagated from underlying transport to database (note - * exceptions are not raised if query not found in database)