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