forester/java/src/org/forester/phylogeny/data/Accession.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
  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 Accession implements PhylogenyData {
  36
  37     final String _value;
  38     final String _source;
  39
  40     public Accession( final String value, final String source ) {
  41         _value = value;
  42         _source = source;
  43     }
  44
  45     public StringBuffer asSimpleText() {
  46         return new StringBuffer( getValue() );
  47     }
  48
  49     public StringBuffer asText() {
  50         final StringBuffer sb = new StringBuffer();
  51         if ( !ForesterUtil.isEmpty( getSource() ) ) {
  52             sb.append( "[" );
  53             sb.append( getSource() );
  54             sb.append( "] " );
  55         }
  56         sb.append( getValue() );
  57         return sb;
  58     }
  59
  60     public PhylogenyData copy() {
  61         return new Accession( new String( getValue() ), new String( getSource() ) );
  62     }
  63
  64     @Override
  65     public boolean equals( final Object o ) {
  66         if ( this == o ) {
  67             return true;
  68         }
  69         else if ( o == null ) {
  70             return false;
  71         }
  72         else if ( o.getClass() != this.getClass() ) {
  73             throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to " + o + " ["
  74                     + o.getClass() + "]" );
  75         }
  76         else {
  77             return isEqual( ( Accession ) o );
  78         }
  79     }
  80
  81     public String getSource() {
  82         return _source;
  83     }
  84
  85     public String getValue() {
  86         return _value;
  87     }
  88
  89     @Override
  90     public int hashCode() {
  91         if ( getSource() != null ) {
  92             return ( getSource() + getValue() ).hashCode();
  93         }
  94         return getValue().hashCode();
  95     }
  96
  97     public boolean isEqual( final PhylogenyData data ) {
  98         if ( this == data ) {
  99             return true;
 100         }
 101         if ( ( data == null ) || ( getValue() == null ) ) {
 102             return false;
 103         }
 104         final Accession a = ( Accession ) data;
 105         if ( ( getSource() != null ) && ( a.getSource() != null ) ) {
 106             return ( a.getValue().equals( getValue() ) && a.getSource().equals( getSource() ) );
 107         }
 108         return ( a.getValue().equals( getValue() ) );
 109     }
 110
 111     public StringBuffer toNHX() {
 112         final StringBuffer sb = new StringBuffer();
 113         sb.append( ":" );
 114         sb.append( NHXtags.SEQUENCE_ACCESSION );
 115         sb.append( ForesterUtil.replaceIllegalNhxCharacters( getValue() ) );
 116         return sb;
 117     }
 118
 119     public void toPhyloXML( final Writer writer, final int level, final String indentation ) throws IOException {
 120         if ( ForesterUtil.isEmpty( getSource() ) ) {
 121             PhylogenyDataUtil.appendElement( writer,
 122                                              PhyloXmlMapping.ACCESSION,
 123                                              getValue(),
 124                                              PhyloXmlMapping.ACCESSION_SOURCE_ATTR,
 125                                              "unknown",
 126                                              indentation );
 127         }
 128         else {
 129             PhylogenyDataUtil.appendElement( writer,
 130                                              PhyloXmlMapping.ACCESSION,
 131                                              getValue(),
 132                                              PhyloXmlMapping.ACCESSION_SOURCE_ATTR,
 133                                              getSource(),
 134                                              indentation );
 135         }
 136     }
 137
 138     @Override
 139     public String toString() {
 140         return asText().toString();
 141     }
 142 }