JAL-1705 additional tests, validation regexp tweaks, javadoc

[jalview.git] / src / jalview / ext / ensembl / EnsemblSequenceFetcher.java

diff --git a/src/jalview/ext/ensembl/EnsemblSequenceFetcher.java b/src/jalview/ext/ensembl/EnsemblSequenceFetcher.java
index f1b96e2..2e32bd2 100644 (file)
--- a/src/jalview/ext/ensembl/EnsemblSequenceFetcher.java
+++ b/src/jalview/ext/ensembl/EnsemblSequenceFetcher.java
@@ -9,13 +9,15 @@ import com.stevesoft.pat.Regex;
  * A base class for Ensembl sequence fetchers
  * 
  * @author gmcarstairs
- *
  */
-public abstract class EnsemblSequenceFetcher extends DbSourceProxyImpl
+abstract class EnsemblSequenceFetcher extends DbSourceProxyImpl
 {
+  // TODO modify to accept other species e.g. ENSMUSTnnn
+  private static final Regex ACCESSION_REGEX = new Regex("((ENSP|ENST|ENSG|CCDS)[0-9.]{3,})");
+
   /*
-   * possible values for the 'feature' parameter of the REST overlap endpoint
-   * @see 
+   * possible values for the 'feature' parameter of the /overlap REST service
+   * @see http://rest.ensembl.org/documentation/info/overlap_id
    */
   protected enum EnsemblFeatureType
   {
@@ -43,10 +45,16 @@ public abstract class EnsemblSequenceFetcher extends DbSourceProxyImpl
     return " ";
   }
 
+  /**
+   * Ensembl accession are ENST + 11 digits for human transcript, ENSG for human
+   * gene. Other species insert 3 letters e.g. ENSMUST..., ENSMUSG...
+   * 
+   * @see http://www.ensembl.org/Help/View?id=151
+   */
   @Override
   public Regex getAccessionValidator()
   {
-    return new Regex("((ENSP|ENST|ENSG|CCDS)[0-9.]{3,})");
+    return ACCESSION_REGEX;
   }
 
   @Override