JAL-1067, JAL-1105 - refactor parser to fit Jalview's data parsing architecture

[jalview.git] / src / jalview / ws / seqfetcher / DbSourceProxy.java

diff --git a/src/jalview/ws/seqfetcher/DbSourceProxy.java b/src/jalview/ws/seqfetcher/DbSourceProxy.java
index c4bbf14..4b9c472 100644 (file)
--- a/src/jalview/ws/seqfetcher/DbSourceProxy.java
+++ b/src/jalview/ws/seqfetcher/DbSourceProxy.java
@@ -1,6 +1,6 @@
 /*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle\r
  * \r
  * This file is part of Jalview.\r
  * \r
@@ -31,7 +31,7 @@ import com.stevesoft.pat.Regex;
  * database (unify with io)\r
  * \r
  * @author JimP\r
- * \r
+ * TODO: promote to API\r
  */\r
 public interface DbSourceProxy\r
 {\r
@@ -100,11 +100,10 @@ public interface DbSourceProxy
   /**\r
    * make one or more queries to the database and attempt to parse the response\r
    * into an alignment\r
-   * \r
-   * @param queries\r
+   * @param queries - one or more queries for database in expected form\r
    * @return null if queries were successful but result was not parsable\r
-   * @throws Exception\r
-   *           TODO\r
+   * @throws Exception - propagated from underlying transport to database (note - exceptions are not raised if query not found in database)\r
+   *           \r
    */\r
   public AlignmentI getSequenceRecords(String queries) throws Exception;\r
 \r
@@ -120,4 +119,12 @@ public interface DbSourceProxy
    * @return one or more string buffers for each individual query\r
    */\r
   public StringBuffer getRawRecords();\r
+\r
+  \r
+  /**\r
+   * Find out more info about the source.\r
+   * @param dbsourceproperty - one of the database reference source properties in jalview.datamodel.DBRefSource\r
+   * @return true if the source has this property\r
+   */\r
+  public boolean isA(Object dbsourceproperty);\r
 }\r