forester/java/src/org/forester/surfacing/SpeciesSpecificDomainSimilariyData.java

   1 // $Id:
   2 // cmzmasek Exp $
   3 //
   4 // FORESTER -- software libraries and applications
   5 // for evolutionary biology research and applications.
   6 //
   7 // Copyright (C) 2008-2009 Christian M. Zmasek
   8 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   9 // All rights reserved
  10 //
  11 // This library is free software; you can redistribute it and/or
  12 // modify it under the terms of the GNU Lesser General Public
  13 // License as published by the Free Software Foundation; either
  14 // version 2.1 of the License, or (at your option) any later version.
  15 //
  16 // This library is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 // Lesser General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU Lesser General Public
  22 // License along with this library; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  24 //
  25 // Contact: phylosoft @ gmail . com
  26 // WWW: www.phylosoft.org/forester
  27
  28 package org.forester.surfacing;
  29
  30 import java.util.SortedMap;
  31
  32 import org.forester.protein.DomainId;
  33
  34 /*
  35  * A helper class for PrintableDomainSimilarity.
  36  */
  37 interface SpeciesSpecificDomainSimilariyData {
  38
  39     public void addProteinsExhibitingCombinationCount( final DomainId domain_id, final int count );
  40
  41     /**
  42      * This should return a sorted map mapping domain ids to their corresponding
  43      * counts
  44      *
  45      * @return a sorted map mapping domain ids to their corresponding counts
  46      */
  47     public SortedMap<DomainId, Integer> getCombinableDomainIdToCountsMap();
  48
  49     public int getNumberOfProteinsExhibitingCombinationWith( final DomainId domain_id );
  50
  51     public StringBuffer toStringBuffer( final DomainSimilarityCalculator.Detailedness detailedness, boolean html );
  52 }