(no commit message)
[jalview.git] / forester / java / src / org / forester / surfacing / CombinableDomains.java
index 581deb3..307da8e 100644 (file)
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 //
 // Contact: phylosoft @ gmail . com
-// WWW: www.phylosoft.org/forester
+// WWW: https://sites.google.com/site/cmzmasek/home/software/forester
 
 package org.forester.surfacing;
 
 import java.util.List;
+import java.util.Set;
 import java.util.SortedMap;
 
-import org.forester.util.DescriptiveStatistics;
+import org.forester.protein.BinaryDomainCombination;
+import org.forester.species.Species;
 
 public interface CombinableDomains {
 
     /**
      * To add a new combinable domain.
-     * 
+     *
      * @param protein_domain
      */
-    public void addCombinableDomain( final DomainId protein_domain );
-
-    /**
-     * 
-     * This must return all domains in this set of combinable domains (i.e.
-     * the key domain and all domains which can combine with the key domain).
-     * 
-     *  @return all domains
-     */
-    List<DomainId> getAllDomains();
-
-    List<DomainId> getCombinableDomains();
+    public void addCombinableDomain( final String protein_domain );
 
     /**
      * Returns the combinable domain identifiers sorted in alphabetical manner: -
      * keys are the combinable domain identifiers - values are the counts of
      * proteins exhibiting a particular combination
-     * 
+     *
      * @return combining domain identifiers sorted in alphabetical manner
      */
-    public SortedMap<DomainId, Integer> getCombinableDomainsIds();
+    public SortedMap<String, Integer> getCombinableDomainsIds();
 
     public StringBuilder getCombiningDomainIdsAsStringBuilder();
 
     /**
      * Returns the domain whose combinable domains are in stored in this
      * combinable domains.
-     * 
+     *
      * @return the domain identifier
      */
-    public DomainId getKeyDomain();
-
-    /**
-     * Gets descriptive statistics for the confidence (i.e. E-values) of the key
-     * domain.
-     * 
-     * 
-     * @return descriptive statistics for the confidence of the key domain
-     */
-    public DescriptiveStatistics getKeyDomainConfidenceDescriptiveStatistics();
+    public String getKeyDomain();
 
     /**
      * Returns how many times the key domain is present in a given species
      * genome.
-     * 
+     *
      * @return key domain count in species
      */
     public int getKeyDomainCount();
 
+    public Set<String> getKeyDomainProteins();
+
     /**
      * Returns how many proteins with the key domain are present in a given
      * species genome.
-     * 
+     *
      * @return key domain proteins count in species
      */
     public int getKeyDomainProteinsCount();
 
     public int getNumberOfCombinableDomains();
 
-    public int getNumberOfProteinsExhibitingCombination( final DomainId protein_domain );
+    public int getNumberOfProteinsExhibitingCombination( final String protein_domain );
 
     /**
      * Returns the species of this combinable domains.
-     * 
+     *
      * @return the species
      */
     public Species getSpecies();
 
-    public boolean isCombinable( final DomainId protein_domain );
+    public boolean isCombinable( final String protein_domain );
+
+    public List<BinaryDomainCombination> toBinaryDomainCombinations();
+
+    void addKeyDomainProtein( String protein );
 
     /**
-     * This is to set descriptive statistics for the confidence (i.e. E-values)
-     * of the key domain.
-     * 
-     * 
-     * @param statistics
+     *
+     * This must return all domains in this set of combinable domains (i.e.
+     * the key domain and all domains which can combine with the key domain).
+     *
+     *  @return all domains
      */
-    void setKeyDomainConfidenceDescriptiveStatistics( final DescriptiveStatistics statistics );
+    List<String> getAllDomains();
+
+    List<String> getCombinableDomains();
 
     /**
      * Sets how many times the key domain is present in a given species genome.
-     * 
+     *
      * @param key_domain_count
      *            key domain count in species
      */
     void setKeyDomainCount( final int key_domain_count );
-
-    /**
-     * Sets how many proteins with the key domain are present in a given species
-     * genome.
-     * 
-     * @param key_domain_proteins_count
-     *            key domain protein count in species
-     */
-    void setKeyDomainProteinsCount( final int key_domain_proteins_count );
-
-    public List<BinaryDomainCombination> toBinaryDomainCombinations();
 }
\ No newline at end of file