forester/java/src/org/forester/surfacing/BasicBinaryDomainCombination.java

   1 // $Id:
   2 // Exp $
   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.HashMap;
  30 import java.util.Map;
  31
  32 import org.forester.protein.BinaryDomainCombination;
  33 import org.forester.util.ForesterUtil;
  34
  35 public class BasicBinaryDomainCombination implements BinaryDomainCombination {
  36
  37     final static Map<Integer, String> id2str = new HashMap<Integer, String>();
  38     final static Map<String, Integer> str2id = new HashMap<String, Integer>();
  39     static short                      count  = 0;
  40     short                             _id0;
  41     short                             _id1;
  42
  43     public static short getId( final String id ) {
  44         if ( !str2id.containsKey( id ) ) {
  45             id2str.put( ( int ) count, id );
  46             str2id.put( id, ( int ) count );
  47             ++count;
  48         }
  49         return Short.valueOf( str2id.get( id ) + "" );
  50     }
  51
  52     public static String getStr( final short id ) {
  53         return id2str.get( id );
  54     }
  55
  56     public BasicBinaryDomainCombination( final String id0, final String id1 ) {
  57         if ( ( id0 == null ) || ( id1 == null ) ) {
  58             throw new IllegalArgumentException( "attempt to create binary domain combination using null" );
  59         }
  60         if ( ( id0.indexOf( SEPARATOR ) != -1 ) || ( id1.indexOf( SEPARATOR ) != -1 ) ) {
  61             throw new IllegalArgumentException( "ill formatted domain id: " + id0 + ", " + id1 );
  62         }
  63         if ( id0.toLowerCase().compareTo( id1.toLowerCase() ) < 0 ) {
  64             //  _data = id0 + SEPARATOR + id1;
  65         }
  66         else {
  67             // _data = id1 + SEPARATOR + id0;
  68         }
  69     }
  70
  71     BasicBinaryDomainCombination() {
  72         _data = null;
  73     }
  74
  75     @Override
  76     public int compareTo( final BinaryDomainCombination binary_domain_combination ) {
  77         if ( binary_domain_combination.getClass() != this.getClass() ) {
  78             throw new IllegalArgumentException( "attempt to compare [" + binary_domain_combination.getClass() + "] to "
  79                     + "[" + this.getClass() + "]" );
  80         }
  81         if ( equals( binary_domain_combination ) ) {
  82             return 0;
  83         }
  84         final int x = getId0().compareTo( binary_domain_combination.getId0() );
  85         if ( x != 0 ) {
  86             return x;
  87         }
  88         else {
  89             return getId1().compareTo( binary_domain_combination.getId1() );
  90         }
  91     }
  92
  93     @Override
  94     public boolean equals( final Object o ) {
  95         if ( this == o ) {
  96             return true;
  97         }
  98         else if ( o == null ) {
  99             throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to null" );
 100         }
 101         else if ( o.getClass() != this.getClass() ) {
 102             throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to ["
 103                     + o.getClass() + "]" );
 104         }
 105         else {
 106             return ( getId0().equals( ( ( BinaryDomainCombination ) o ).getId0() ) )
 107                     && ( getId1().equals( ( ( BinaryDomainCombination ) o ).getId1() ) );
 108         }
 109     }
 110
 111     @Override
 112     public String getId0() {
 113         return _data.substring( 0, _data.indexOf( SEPARATOR ) );
 114     }
 115
 116     @Override
 117     public String getId1() {
 118         return _data.substring( _data.indexOf( SEPARATOR ) + 1 );
 119     }
 120
 121     @Override
 122     public int hashCode() {
 123         return getAsStr().hashCode();
 124     }
 125
 126     @Override
 127     public StringBuffer toGraphDescribingLanguage( final OutputFormat format,
 128                                                    final String node_attribute,
 129                                                    final String edge_attribute ) {
 130         final StringBuffer sb = new StringBuffer();
 131         switch ( format ) {
 132             case DOT:
 133                 if ( ForesterUtil.isEmpty( node_attribute ) ) {
 134                     sb.append( getId0() );
 135                     sb.append( " -- " );
 136                     sb.append( getId1() );
 137                     if ( !ForesterUtil.isEmpty( edge_attribute ) ) {
 138                         sb.append( " " );
 139                         sb.append( edge_attribute );
 140                     }
 141                     sb.append( ";" );
 142                 }
 143                 else {
 144                     sb.append( getId0() );
 145                     sb.append( " " );
 146                     sb.append( node_attribute );
 147                     sb.append( ";" );
 148                     sb.append( ForesterUtil.LINE_SEPARATOR );
 149                     sb.append( getId1() );
 150                     sb.append( " " );
 151                     sb.append( node_attribute );
 152                     sb.append( ";" );
 153                     sb.append( ForesterUtil.LINE_SEPARATOR );
 154                     sb.append( getId0() );
 155                     sb.append( " -- " );
 156                     sb.append( getId1() );
 157                     if ( !ForesterUtil.isEmpty( edge_attribute ) ) {
 158                         sb.append( " " );
 159                         sb.append( edge_attribute );
 160                     }
 161                     sb.append( ";" );
 162                 }
 163                 break;
 164             default:
 165                 throw new AssertionError( "unknown format:" + format );
 166         }
 167         return sb;
 168     }
 169
 170     @Override
 171     public String toString() {
 172         return getAsStr();
 173     }
 174
 175     private String getAsStr() {
 176         return _data;
 177     }
 178
 179     public static BinaryDomainCombination createInstance( final String ids ) {
 180         if ( ids.indexOf( BinaryDomainCombination.SEPARATOR ) < 1 ) {
 181             throw new IllegalArgumentException( "Unexpected format for binary domain combination [" + ids + "]" );
 182         }
 183         final String[] ids_ary = ids.split( BinaryDomainCombination.SEPARATOR );
 184         if ( ids_ary.length != 2 ) {
 185             throw new IllegalArgumentException( "Unexpected format for binary domain combination [" + ids + "]" );
 186         }
 187         return new BasicBinaryDomainCombination( ids_ary[ 0 ], ids_ary[ 1 ] );
 188     }
 189 }