forester/java/src/org/forester/surfacing/DomainSimilarity.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: https://sites.google.com/site/cmzmasek/home/software/forester
  26
  27 package org.forester.surfacing;
  28
  29 import java.util.Map;
  30 import java.util.SortedMap;
  31 import java.util.SortedSet;
  32
  33 import org.forester.phylogeny.Phylogeny;
  34 import org.forester.species.Species;
  35 import org.forester.surfacing.PrintableDomainSimilarity.PRINT_OPTION;
  36
  37 /*
  38  * This is to represent a measure of similarity between two or more domains from
  39  * different genomes.
  40  */
  41 public interface DomainSimilarity extends Comparable<DomainSimilarity> {
  42
  43     static public enum DomainSimilarityScoring {
  44         DOMAINS, PROTEINS, COMBINATIONS;
  45     }
  46
  47     public static enum DomainSimilaritySortField {
  48         MIN, MAX, SD, MEAN, ABS_MAX_COUNTS_DIFFERENCE, MAX_COUNTS_DIFFERENCE, MAX_DIFFERENCE, SPECIES_COUNT, DOMAIN_ID,
  49     }
  50
  51     public SortedSet<String> getCombinableDomainIds( final Species species_of_combinable_domain );
  52
  53     public String getDomainId();
  54
  55     /**
  56      * For pairwise similarities, this should return the "difference"; for example the difference in counts
  57      * for copy number based features (the same as getMaximalDifferenceInCounts(), or the number
  58      * of actually different domain combinations.
  59      * For pairwise similarities, this should return the difference,
  60      * while for comparisons of more than two domains, this should return the maximal difference
  61      *
  62      *
  63      *
  64      * @return
  65      */
  66     public int getMaximalDifference();
  67
  68     /**
  69      * For pairwise similarities, this should return the difference in counts,
  70      * while for comparisons of more than two domains, this should return the maximal difference
  71      * in counts
  72      *
  73      *
  74      * @return the (maximal) difference in counts
  75      */
  76     public int getMaximalDifferenceInCounts();
  77
  78     public double getMaximalSimilarityScore();
  79
  80     public double getMeanSimilarityScore();
  81
  82     public double getMinimalSimilarityScore();
  83
  84     /**
  85      * This should return the number of pairwise distances used to calculate
  86      * this similarity score
  87      *
  88      * @return the number of pairwise distances
  89      */
  90     public int getN();
  91
  92     public SortedSet<Species> getSpecies();
  93
  94     /**
  95      * This should return a map, which maps species names to
  96      * SpeciesSpecificDomainSimilariyData
  97      *
  98      *
  99      * @return SortedMap<String, SpeciesSpecificDomainSimilariyData>
 100      */
 101     public SortedMap<Species, SpeciesSpecificDcData> getSpeciesData();
 102
 103     public double getStandardDeviationOfSimilarityScore();
 104
 105     public StringBuffer toStringBuffer( PRINT_OPTION print_option,
 106                                         Map<String, Integer> tax_code_to_id_map,
 107                                         Phylogeny phy );
 108 }