forester/java/src/org/forester/phylogeny/data/Identifier.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.phylogeny.data;
  27
  28 import java.io.IOException;
  29 import java.io.Writer;
  30
  31 import org.forester.io.parsers.nhx.NHXtags;
  32 import org.forester.io.parsers.phyloxml.PhyloXmlMapping;
  33 import org.forester.util.ForesterUtil;
  34
  35 public class Identifier implements PhylogenyData {
  36
  37     final String _value;
  38     final String _provider;
  39
  40     public Identifier() {
  41         _value = "";
  42         _provider = "";
  43     }
  44
  45     public Identifier( final String value ) {
  46         _value = value;
  47         _provider = "";
  48     }
  49
  50     public Identifier( final String value, final String provider ) {
  51         _value = value;
  52         _provider = provider;
  53     }
  54
  55     public StringBuffer asSimpleText() {
  56         return new StringBuffer( getValue() );
  57     }
  58
  59     public StringBuffer asText() {
  60         final StringBuffer sb = new StringBuffer();
  61         if ( !ForesterUtil.isEmpty( getProvider() ) ) {
  62             sb.append( "[" );
  63             sb.append( getProvider() );
  64             sb.append( "] " );
  65         }
  66         sb.append( getValue() );
  67         return sb;
  68     }
  69
  70     public PhylogenyData copy() {
  71         return new Identifier( getValue(), getProvider() );
  72     }
  73
  74     @Override
  75     public boolean equals( final Object o ) {
  76         if ( this == o ) {
  77             return true;
  78         }
  79         else if ( o == null ) {
  80             return false;
  81         }
  82         else if ( o.getClass() != this.getClass() ) {
  83             throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to " + o + " ["
  84                     + o.getClass() + "]" );
  85         }
  86         else {
  87             return isEqual( ( Identifier ) o );
  88         }
  89     }
  90
  91     public String getProvider() {
  92         return _provider;
  93     }
  94
  95     public String getValue() {
  96         return _value;
  97     }
  98
  99     @Override
 100     public int hashCode() {
 101         if ( getProvider() != null ) {
 102             return ( getProvider() + getValue() ).hashCode();
 103         }
 104         return getValue().hashCode();
 105     }
 106
 107     public boolean isEqual( final PhylogenyData data ) {
 108         if ( this == data ) {
 109             return true;
 110         }
 111         if ( ( data == null ) || ( getValue() == null ) ) {
 112             return false;
 113         }
 114         final Identifier a = ( Identifier ) data;
 115         if ( ( getProvider() != null ) && ( a.getProvider() != null ) ) {
 116             return ( a.getValue().equals( getValue() ) && a.getProvider().equals( getProvider() ) );
 117         }
 118         return ( a.getValue().equals( getValue() ) );
 119     }
 120
 121     public StringBuffer toNHX() {
 122         final StringBuffer sb = new StringBuffer();
 123         sb.append( ":" );
 124         sb.append( NHXtags.NODE_IDENTIFIER );
 125         sb.append( ForesterUtil.replaceIllegalNhxCharacters( getValue() ) );
 126         return sb;
 127     }
 128
 129     public void toPhyloXML( final Writer writer, final int level, final String indentation ) throws IOException {
 130         if ( !org.forester.util.ForesterUtil.isEmpty( getProvider() ) ) {
 131             PhylogenyDataUtil.appendElement( writer,
 132                                              PhyloXmlMapping.IDENTIFIER,
 133                                              getValue(),
 134                                              PhyloXmlMapping.IDENTIFIER_PROVIDER_ATTR,
 135                                              getProvider(),
 136                                              indentation );
 137         }
 138         else {
 139             PhylogenyDataUtil.appendElement( writer, PhyloXmlMapping.IDENTIFIER, getValue(), indentation );
 140         }
 141     }
 142
 143     @Override
 144     public String toString() {
 145         return asText().toString();
 146     }
 147 }