X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fws%2Fdbsources%2FPfam.java;h=37108ca07c1d55047b9dcc057473ffb67d70e02a;hb=797df64fa2a0a30773d0f48f5494d4155e5a8be3;hp=4077c51d885d29f3dc540b5be55caf81dbcb9739;hpb=0eda2ac2f334f55f6e5f137789453a9f4dfe4d73;p=jalview.git

diff --git a/src/jalview/ws/dbsources/Pfam.java b/src/jalview/ws/dbsources/Pfam.java
index 4077c51..37108ca 100644
--- a/src/jalview/ws/dbsources/Pfam.java
+++ b/src/jalview/ws/dbsources/Pfam.java
@@ -1,5 +1,19 @@
-/**
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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.dbsources;
 
@@ -8,19 +22,36 @@ import java.util.Hashtable;
 import com.stevesoft.pat.Regex;
 
 import jalview.datamodel.AlignmentI;
+import jalview.datamodel.DBRefEntry;
+import jalview.io.AppletFormatAdapter;
+import jalview.io.FastaFile;
+import jalview.io.StockholmFile;
 import jalview.ws.seqfetcher.DbSourceProxy;
 import jalview.ws.seqfetcher.DbSourceProxyImpl;
+
 /**
- * TODO: later PFAM is a complex datasource - it currently returns a seed alignment, but could optionally return a full alignment.
- * TODO: later PFAM is a complex datasource - it could return a tree in addition to an alignment
- * TODO: HP: Incorporate jalview.gui.SequenceFetcher retrieval code here.
+ * TODO: later PFAM is a complex datasource - it could return a tree in addition
+ * to an alignment TODO: create interface to pass alignment properties and tree
+ * back to sequence fetcher
+ * 
  * @author JimP
- *
+ * 
  */
-public class Pfam extends DbSourceProxyImpl implements DbSourceProxy
+abstract public class Pfam extends Xfam implements
+        DbSourceProxy
 {
 
-  /* (non-Javadoc)
+  public Pfam()
+  {
+    super();
+    // all extensions of this PFAM source base class are DOMAINDB sources
+    addDbSourceProperty(jalview.datamodel.DBRefSource.DOMAINDB);
+    addDbSourceProperty(jalview.datamodel.DBRefSource.ALIGNMENTDB);
+  }
+
+  /*
+   * (non-Javadoc)
+   * 
    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
    */
   public String getAccessionSeparator()
@@ -29,7 +60,9 @@ public class Pfam extends DbSourceProxyImpl implements DbSourceProxy
     return null;
   }
 
-  /* (non-Javadoc)
+  /*
+   * (non-Javadoc)
+   * 
    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
    */
   public Regex getAccessionValidator()
@@ -38,71 +71,91 @@ public class Pfam extends DbSourceProxyImpl implements DbSourceProxy
     return null;
   }
 
-  /* (non-Javadoc)
-   * @see jalview.ws.DbSourceProxy#getDbSource()
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
+   * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
+   * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an
+   * 'alignment' source - means proxy is higher level than a sequence source.
+   * return jalview.datamodel.DBRefSource.PFAM; }
    */
-  public String getDbSource()
-  {
-    // TODO Auto-generated method stub
-    return jalview.datamodel.DBRefSource.PFAM;
-  }
 
-  /* (non-Javadoc)
-   * @see jalview.ws.DbSourceProxy#getDbSourceProperties()
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable
+   * getDbSourceProperties() {
+   * 
+   * return null; }
    */
-  public Hashtable getDbSourceProperties()
-  {
-    // TODO Auto-generated method stub
-    return null;
-  }
 
-  /* (non-Javadoc)
+  /*
+   * (non-Javadoc)
+   * 
    * @see jalview.ws.DbSourceProxy#getDbVersion()
    */
-  public String getDbVersion()
+  @Override
+public String getDbVersion()
   {
     // TODO Auto-generated method stub
     return null;
   }
 
-  /* (non-Javadoc)
-   * @see jalview.ws.DbSourceProxy#getRawRecords()
+  /**Returns base URL for selected Pfam alignment type
+   * 
+   * @return PFAM URL stub for this DbSource
    */
-  public StringBuffer getRawRecords()
-  {
-    // TODO Auto-generated method stub
-    return null;
-  }
+  @Override
+protected abstract String getXFAMURL();
 
-  /* (non-Javadoc)
+  /*
+   * (non-Javadoc)
+   * 
    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])
    */
   public AlignmentI getSequenceRecords(String queries) throws Exception
   {
-    throw new Exception("PFAM Retrieval not yet implemented - see jalview.gui.SequenceFetcher for current implementation");
+    // TODO: this is not a perfect implementation. We need to be able to add
+    // individual references to each sequence in each family alignment that's
+    // retrieved.
+    startQuery();
+    AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getXFAMURL()
+            + queries.trim().toUpperCase(), jalview.io.FormatAdapter.URL,
+            "STH");
+    for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
+    {
+      rcds.getSequenceAt(s).addDBRef(
+              new DBRefEntry(jalview.datamodel.DBRefSource.PFAM,
+              // getDbSource(),
+                      getDbVersion(), queries.trim().toUpperCase()));
+      if (!getDbSource().equals(jalview.datamodel.DBRefSource.PFAM))
+      { // add the specific ref too
+        rcds.getSequenceAt(s).addDBRef(
+                new DBRefEntry(getDbSource(), getDbVersion(), queries
+                        .trim().toUpperCase()));
+      }
+    }
+    stopQuery();
+    return rcds;
   }
 
-  /* (non-Javadoc)
+  /*
+   * (non-Javadoc)
+   * 
    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
    */
   public boolean isValidReference(String accession)
   {
-    // TODO Auto-generated method stub
-    return false;
+    return accession.indexOf("PF") == 0;
   }
 
-  /* (non-Javadoc)
-   * @see jalview.ws.DbSourceProxy#queryInProgress()
+  /*
+   * public String getDbName() { return "PFAM"; // getDbSource(); }
    */
-  public boolean queryInProgress()
-  {
-    // TODO Auto-generated method stub
-    return false;
-  }
-
-  public String getTestQuery()
-  {
-    return "PF00535";
-  }
-
+  
+  
+  public String getXfamSource() { return jalview.datamodel.DBRefSource.PFAM; }
+  
+  
 }