JAL-1967 JAL-1479 refactored sequence<->structure mapping implementation

[jalview.git] / src / jalview / api / SiftsClientI.java

diff --git a/src/jalview/api/SiftsClientI.java b/src/jalview/api/SiftsClientI.java
index 13223af..e2fac14 100644 (file)
--- a/src/jalview/api/SiftsClientI.java
+++ b/src/jalview/api/SiftsClientI.java
@@ -22,8 +22,11 @@ package jalview.api;
 
 import jalview.datamodel.SequenceI;
 import jalview.structure.StructureMapping;
+import jalview.ws.sifts.MappingOutputPojo;
+import jalview.ws.sifts.SiftsException;
 import jalview.xml.binding.sifts.Entry.Entity;
 
+import java.util.HashMap;
 import java.util.HashSet;
 
 public interface SiftsClientI
@@ -78,7 +81,7 @@ public interface SiftsClientI
    * @return Entity
    * @throws Exception
    */
-  public Entity getEntityById(String id) throws Exception;
+  public Entity getEntityById(String id) throws SiftsException;
 
   /**
    * Get all accession Ids available in the current SIFTs entry
@@ -93,7 +96,7 @@ public interface SiftsClientI
    * @param accessionId
    * @return
    */
-  public boolean isFoundInSiftsEntry(String accessionId);
+  public boolean isAccessionMatched(String accessionId);
 
   /**
    * Get the standard DB referenced by the SIFTs Entry
@@ -103,27 +106,14 @@ public interface SiftsClientI
   public String[] getEntryDBs();
 
   /**
-   * Get the SIFTs Entry details
-   */
-  public void getEntryDetails();
-
-  /**
    * 
-   * @param seq1
-   *          Sequence to map
-   * @param seq2
-   *          Structure Sequence
-   * @param seqID1
-   *          sequence id
-   * @param seqID2
-   *          structure sequence id
-   * @param seqType
-   *          type of sequence for the mapping (pep or protein)
-   * @param nochunks
-   * @return sequence->structure mapping as int [][]
+   * @param mop
+   *          MappingOutputPojo
+   * @return Sequence<->Structure mapping as int[][]
+   * @throws SiftsException
    */
-  public StringBuffer getMappingOutput(String seq1, String seq2,
-          String seqID1, String seqID2, String seqType, int nochunks);
+  public StringBuffer getMappingOutput(MappingOutputPojo mop)
+          throws SiftsException;
 
   /**
    * 
@@ -134,9 +124,10 @@ public interface SiftsClientI
    * @param chain
    *          the chain of the entry to use for mapping
    * @return StructureMapping
+   * @throws SiftsException
    */
-  public StructureMapping getSiftsStructureMapping(SequenceI seq, String pdbFile,
-          String chain);
+  public StructureMapping getSiftsStructureMapping(SequenceI seq,
+          String pdbFile, String chain) throws SiftsException;
   
   /**
    * Get residue by residue mapping for a given Sequence and SIFTs entity
@@ -148,6 +139,7 @@ public interface SiftsClientI
    * @return generated mapping
    * @throws Exception
    */
-  public int[][] getGreedyMapping(String entityId, SequenceI seq,
-          java.io.PrintStream os) throws Exception;
+  public HashMap<Integer, int[]> getGreedyMapping(String entityId,
+          SequenceI seq,
+          java.io.PrintStream os) throws SiftsException;
 }
\ No newline at end of file