forester/java/src/org/forester/surfacing/CombinableDomains.java

   1 // $Id:
   2 //
   3 // FORESTER -- software libraries and applications
   4 // for evolutionary biology research and applications.
   5 //
   6 // Copyright (C) 2008-2009 Christian M. Zmasek
   7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   8 // All rights reserved
   9 //
  10 // This library is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU Lesser General Public
  12 // License as published by the Free Software Foundation; either
  13 // version 2.1 of the License, or (at your option) any later version.
  14 //
  15 // This library is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 // Lesser General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU Lesser General Public
  21 // License along with this library; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  23 //
  24 // Contact: phylosoft @ gmail . com
  25 // WWW: www.phylosoft.org/forester
  26
  27 package org.forester.surfacing;
  28
  29 import java.util.List;
  30 import java.util.SortedMap;
  31
  32 import org.forester.util.DescriptiveStatistics;
  33
  34 public interface CombinableDomains {
  35
  36     /**
  37      * To add a new combinable domain.
  38      *
  39      * @param protein_domain
  40      */
  41     public void addCombinableDomain( final DomainId protein_domain );
  42
  43     /**
  44      *
  45      * This must return all domains in this set of combinable domains (i.e.
  46      * the key domain and all domains which can combine with the key domain).
  47      *
  48      *  @return all domains
  49      */
  50     List<DomainId> getAllDomains();
  51
  52     List<DomainId> getCombinableDomains();
  53
  54     /**
  55      * Returns the combinable domain identifiers sorted in alphabetical manner: -
  56      * keys are the combinable domain identifiers - values are the counts of
  57      * proteins exhibiting a particular combination
  58      *
  59      * @return combining domain identifiers sorted in alphabetical manner
  60      */
  61     public SortedMap<DomainId, Integer> getCombinableDomainsIds();
  62
  63     public StringBuilder getCombiningDomainIdsAsStringBuilder();
  64
  65     /**
  66      * Returns the domain whose combinable domains are in stored in this
  67      * combinable domains.
  68      *
  69      * @return the domain identifier
  70      */
  71     public DomainId getKeyDomain();
  72
  73     /**
  74      * Gets descriptive statistics for the confidence (i.e. E-values) of the key
  75      * domain.
  76      *
  77      *
  78      * @return descriptive statistics for the confidence of the key domain
  79      */
  80     public DescriptiveStatistics getKeyDomainConfidenceDescriptiveStatistics();
  81
  82     /**
  83      * Returns how many times the key domain is present in a given species
  84      * genome.
  85      *
  86      * @return key domain count in species
  87      */
  88     public int getKeyDomainCount();
  89
  90     /**
  91      * Returns how many proteins with the key domain are present in a given
  92      * species genome.
  93      *
  94      * @return key domain proteins count in species
  95      */
  96     public int getKeyDomainProteinsCount();
  97
  98     public int getNumberOfCombinableDomains();
  99
 100     public int getNumberOfProteinsExhibitingCombination( final DomainId protein_domain );
 101
 102     /**
 103      * Returns the species of this combinable domains.
 104      *
 105      * @return the species
 106      */
 107     public Species getSpecies();
 108
 109     public boolean isCombinable( final DomainId protein_domain );
 110
 111     /**
 112      * This is to set descriptive statistics for the confidence (i.e. E-values)
 113      * of the key domain.
 114      *
 115      *
 116      * @param statistics
 117      */
 118     void setKeyDomainConfidenceDescriptiveStatistics( final DescriptiveStatistics statistics );
 119
 120     /**
 121      * Sets how many times the key domain is present in a given species genome.
 122      *
 123      * @param key_domain_count
 124      *            key domain count in species
 125      */
 126     void setKeyDomainCount( final int key_domain_count );
 127
 128     /**
 129      * Sets how many proteins with the key domain are present in a given species
 130      * genome.
 131      *
 132      * @param key_domain_proteins_count
 133      *            key domain protein count in species
 134      */
 135     void setKeyDomainProteinsCount( final int key_domain_proteins_count );
 136
 137     public List<BinaryDomainCombination> toBinaryDomainCombinations();
 138 }