forester/java/src/org/forester/surfacing/PrintableSpeciesSpecificDcData.java

   1 // $Id:
   2 // 22:09:42 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: https://sites.google.com/site/cmzmasek/home/software/forester
  27
  28 package org.forester.surfacing;
  29
  30 import java.util.Set;
  31 import java.util.SortedMap;
  32 import java.util.SortedSet;
  33 import java.util.TreeMap;
  34 import java.util.TreeSet;
  35
  36 import org.forester.util.ForesterUtil;
  37
  38 class PrintableSpeciesSpecificDcData implements SpeciesSpecificDcData {
  39
  40     final SortedMap<String, Integer> _combinable_domain_id_to_count_map;
  41     final SortedSet<String>          _key_domain_proteins;
  42     final private int                _key_domain_domains_count;
  43     final private int                _combinable_domains_count;
  44
  45     public PrintableSpeciesSpecificDcData( final int key_domain_domains_count, final int combinable_domains ) {
  46         _key_domain_proteins = new TreeSet<String>();
  47         _key_domain_domains_count = key_domain_domains_count;
  48         _combinable_domains_count = combinable_domains;
  49         _combinable_domain_id_to_count_map = new TreeMap<String, Integer>();
  50     }
  51
  52     @Override
  53     public void addProteinsExhibitingCombinationCount( final String domain_id, final int count ) {
  54         if ( getCombinableDomainIdToCountsMap().containsKey( domain_id ) ) {
  55             throw new IllegalArgumentException( "Domain with id " + domain_id + " already exists" );
  56         }
  57         getCombinableDomainIdToCountsMap().put( domain_id, count );
  58     }
  59
  60     @Override
  61     public SortedMap<String, Integer> getCombinableDomainIdToCountsMap() {
  62         return _combinable_domain_id_to_count_map;
  63     }
  64
  65     private int getCombinableDomainsCount() {
  66         return _combinable_domains_count;
  67     }
  68
  69     private int getKeyDomainDomainsCount() {
  70         return _key_domain_domains_count;
  71     }
  72
  73     private int getKeyDomainProteinsCount() {
  74         return _key_domain_proteins.size();
  75     }
  76
  77     @Override
  78     public int getNumberOfProteinsExhibitingCombinationWith( final String domain_id ) {
  79         if ( !getCombinableDomainIdToCountsMap().containsKey( domain_id ) ) {
  80             throw new IllegalArgumentException( "Domain with id " + domain_id + " not found" );
  81         }
  82         return getCombinableDomainIdToCountsMap().get( domain_id );
  83     }
  84
  85     @Override
  86     public void addKeyDomainProtein( final String protein ) {
  87         if ( ForesterUtil.isEmpty( protein ) ) {
  88             throw new IllegalArgumentException( "attempt to add null or empty protein" );
  89         }
  90         if ( getKeyDomainProteins().contains( protein ) ) {
  91             throw new IllegalArgumentException( "protein \"" + protein + "\" is not unique" );
  92         }
  93         getKeyDomainProteins().add( protein );
  94     }
  95
  96     @Override
  97     public SortedSet<String> getKeyDomainProteins() {
  98         return _key_domain_proteins;
  99     }
 100
 101     @Override
 102     public String toString() {
 103         return toStringBuffer( DomainSimilarityCalculator.Detailedness.LIST_COMBINING_DOMAIN_FOR_EACH_SPECIES, false )
 104                 .toString();
 105     }
 106
 107     @Override
 108     public StringBuffer toStringBuffer( final DomainSimilarityCalculator.Detailedness detailedness, final boolean html ) {
 109         final StringBuffer sb = new StringBuffer();
 110         if ( detailedness == DomainSimilarityCalculator.Detailedness.PUNCTILIOUS ) {
 111             sb.append( " " );
 112             sb.append( getKeyDomainDomainsCount() );
 113             sb.append( ", " );
 114             sb.append( getKeyDomainProteinsCount() );
 115             sb.append( ", " );
 116             sb.append( getCombinableDomainsCount() );
 117             if ( !getCombinableDomainIdToCountsMap().isEmpty() ) {
 118                 sb.append( ":" );
 119             }
 120         }
 121         final Set<String> ids = getCombinableDomainIdToCountsMap().keySet();
 122         int i = 0;
 123         for( final String domain_id : ids ) {
 124             ++i;
 125             sb.append( " " );
 126             if ( html ) {
 127                 sb.append( "<a href=\"" + SurfacingConstants.PFAM_FAMILY_ID_LINK + domain_id + "\">" + domain_id
 128                         + "</a>" );
 129             }
 130             else {
 131                 sb.append( domain_id );
 132             }
 133             if ( detailedness == DomainSimilarityCalculator.Detailedness.PUNCTILIOUS ) {
 134                 sb.append( ":" );
 135                 sb.append( getCombinableDomainIdToCountsMap().get( domain_id ) );
 136             }
 137         }
 138         sb.append( " [" );
 139         boolean first = true;
 140         for( final String p : getKeyDomainProteins() ) {
 141             String link = null;
 142             final String up_id = ForesterUtil.extractUniProtKbProteinSeqIdentifier( p );
 143             if ( !ForesterUtil.isEmpty( up_id ) ) {
 144                 link = "<a href=\"" + ForesterUtil.UNIPROT_KB + up_id + "\" target=\"_up_window\">" + up_id + "</a>";
 145             }
 146             else {
 147                 link = "<a href=\"" + "http://www.google.com/search?q=" + p + "\" target=\"_g_window\">" + p + "</a>";
 148             }
 149             if ( first ) {
 150                 first = false;
 151             }
 152             else {
 153                 sb.append( ", " );
 154             }
 155             sb.append( p );
 156         }
 157         sb.append( "]" );
 158         return sb;
 159     }
 160 }