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