forester/java/src/org/forester/phylogeny/data/Confidence.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.io.parsers.phyloxml.PhyloXmlUtil;
  34 import org.forester.util.ForesterUtil;
  35
  36 public class Confidence implements PhylogenyData, Comparable<Confidence> {
  37
  38     public final static double CONFIDENCE_DEFAULT_VALUE = -9999.0;
  39     private double             _value;
  40     private String             _type;
  41
  42     public Confidence() {
  43         init();
  44     }
  45
  46     public Confidence( final double value, final String type ) {
  47         setValue( value );
  48         setType( type );
  49     }
  50
  51     @Override
  52     public StringBuffer asSimpleText() {
  53         return new StringBuffer().append( ForesterUtil.FORMATTER_6.format( getValue() ) );
  54     }
  55
  56     @Override
  57     public StringBuffer asText() {
  58         final StringBuffer sb = new StringBuffer();
  59         if ( !ForesterUtil.isEmpty( getType() ) ) {
  60             sb.append( "[" );
  61             sb.append( getType() );
  62             sb.append( "] " );
  63         }
  64         sb.append( ForesterUtil.FORMATTER_6.format( getValue() ) );
  65         return sb;
  66     }
  67
  68     @Override
  69     public int compareTo( final Confidence confidence ) {
  70         if ( this == confidence ) {
  71             return 0;
  72         }
  73         return getType().compareToIgnoreCase( confidence.getType() );
  74     }
  75
  76     @Override
  77     public PhylogenyData copy() {
  78         return new Confidence( getValue(), getType() );
  79     }
  80
  81     public String getType() {
  82         return _type;
  83     }
  84
  85     public double getValue() {
  86         return _value;
  87     }
  88
  89     public void init() {
  90         setValue( CONFIDENCE_DEFAULT_VALUE );
  91         setType( "" );
  92     }
  93
  94     @Override
  95     public boolean isEqual( final PhylogenyData confidence ) {
  96         if ( confidence == null ) {
  97             return false;
  98         }
  99         if ( !( confidence instanceof Confidence ) ) {
 100             return false;
 101         }
 102         final Confidence s = ( Confidence ) confidence;
 103         if ( s.getValue() != getValue() ) {
 104             return false;
 105         }
 106         if ( !s.getType().equals( getType() ) ) {
 107             return false;
 108         }
 109         return true;
 110     }
 111
 112     public void setType( final String type ) {
 113         _type = type;
 114     }
 115
 116     public void setValue( final double value ) {
 117         _value = value;
 118     }
 119
 120     @Override
 121     public StringBuffer toNHX() {
 122         final StringBuffer sb = new StringBuffer();
 123         sb.append( NHXtags.SUPPORT );
 124         sb.append( getValue() );
 125         return sb;
 126     }
 127
 128     @Override
 129     public void toPhyloXML( final Writer writer, final int level, final String indentation ) throws IOException {
 130         if ( getValue() == CONFIDENCE_DEFAULT_VALUE ) {
 131             return;
 132         }
 133         writer.write( ForesterUtil.LINE_SEPARATOR );
 134         writer.write( indentation );
 135         PhylogenyDataUtil.appendElement( writer,
 136                                          PhyloXmlMapping.CONFIDENCE,
 137                                          String.valueOf( ForesterUtil
 138                                                  .round( getValue(),
 139                                                          PhyloXmlUtil.ROUNDING_DIGITS_FOR_PHYLOXML_DOUBLE_OUTPUT ) ),
 140                                          PhyloXmlMapping.CONFIDENCE_TYPE_ATTR,
 141                                          ForesterUtil.isEmpty( getType() ) ? "unknown" : getType() );
 142     }
 143
 144     @Override
 145     public String toString() {
 146         return asText().toString();
 147     }
 148 }