2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2008-2009 Christian M. Zmasek
6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
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.
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.
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
23 // Contact: phylosoft @ gmail . com
24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
26 package org.forester.phylogeny.data;
28 import java.io.IOException;
29 import java.io.Writer;
31 import org.forester.io.parsers.phyloxml.PhyloXmlMapping;
32 import org.forester.util.ForesterUtil;
34 public final class Identifier implements PhylogenyData {
36 final private String _value;
37 final private String _provider;
38 final private String _value_provider;
46 public Identifier( final String value ) {
49 _value_provider = value;
52 public Identifier( final String value, final String provider ) {
55 if ( provider != null ) {
56 _value_provider = value + provider;
59 _value_provider = value;
64 public StringBuffer asSimpleText() {
65 return new StringBuffer( getValue() );
69 public StringBuffer asText() {
70 final StringBuffer sb = new StringBuffer();
71 if ( !ForesterUtil.isEmpty( getProvider() ) ) {
73 sb.append( getProvider() );
76 sb.append( getValue() );
80 public String getValuePlusProvider() {
81 return _value_provider;
85 public PhylogenyData copy() {
86 return new Identifier( getValue(), getProvider() );
90 public boolean equals( final Object o ) {
94 else if ( o == null ) {
97 else if ( o.getClass() != this.getClass() ) {
98 throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to " + o + " ["
99 + o.getClass() + "]" );
102 return isEqual( ( Identifier ) o );
106 public String getProvider() {
110 public String getValue() {
115 public int hashCode() {
116 return _value_provider.hashCode();
120 public boolean isEqual( final PhylogenyData data ) {
121 if ( this == data ) {
124 if ( ( data == null ) || ( getValue() == null ) ) {
127 final Identifier a = ( Identifier ) data;
128 if ( ( getProvider() != null ) && ( a.getProvider() != null ) ) {
129 return ( a.getValue().equals( getValue() ) && a.getProvider().equals( getProvider() ) );
131 return ( a.getValue().equals( getValue() ) );
135 public StringBuffer toNHX() {
136 throw new UnsupportedOperationException();
140 public void toPhyloXML( final Writer writer, final int level, final String indentation ) throws IOException {
141 if ( !org.forester.util.ForesterUtil.isEmpty( getProvider() ) ) {
142 PhylogenyDataUtil.appendElement( writer,
143 PhyloXmlMapping.IDENTIFIER,
145 PhyloXmlMapping.IDENTIFIER_PROVIDER_ATTR,
150 PhylogenyDataUtil.appendElement( writer, PhyloXmlMapping.IDENTIFIER, getValue(), indentation );
155 public String toString() {
156 return asText().toString();