3 // FORESTER -- software libraries and applications
4 // for evolutionary biology research and applications.
6 // Copyright (C) 2008-2009 Christian M. Zmasek
7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
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.
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.
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
24 // Contact: phylosoft @ gmail . com
25 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
27 package org.forester.surfacing;
29 import java.util.List;
31 import java.util.SortedMap;
33 import org.forester.protein.BinaryDomainCombination;
34 import org.forester.species.Species;
36 public interface CombinableDomains {
39 * To add a new combinable domain.
41 * @param protein_domain
43 public void addCombinableDomain( final String protein_domain );
46 * Returns the combinable domain identifiers sorted in alphabetical manner: -
47 * keys are the combinable domain identifiers - values are the counts of
48 * proteins exhibiting a particular combination
50 * @return combining domain identifiers sorted in alphabetical manner
52 public SortedMap<String, Integer> getCombinableDomainsIds();
54 public StringBuilder getCombiningDomainIdsAsStringBuilder();
57 * Returns the domain whose combinable domains are in stored in this
60 * @return the domain identifier
62 public String getKeyDomain();
65 * Returns how many times the key domain is present in a given species
68 * @return key domain count in species
70 public int getKeyDomainCount();
72 public Set<String> getKeyDomainProteins();
75 * Returns how many proteins with the key domain are present in a given
78 * @return key domain proteins count in species
80 public int getKeyDomainProteinsCount();
82 public int getNumberOfCombinableDomains();
84 public int getNumberOfProteinsExhibitingCombination( final String protein_domain );
87 * Returns the species of this combinable domains.
91 public Species getSpecies();
93 public boolean isCombinable( final String protein_domain );
95 public List<BinaryDomainCombination> toBinaryDomainCombinations();
97 void addKeyDomainProtein( String protein );
101 * This must return all domains in this set of combinable domains (i.e.
102 * the key domain and all domains which can combine with the key domain).
104 * @return all domains
106 List<String> getAllDomains();
108 List<String> getCombinableDomains();
111 * Sets how many times the key domain is present in a given species genome.
113 * @param key_domain_count
114 * key domain count in species
116 void setKeyDomainCount( final int key_domain_count );