forester/java/src/org/forester/phylogeny/data/PhylogenyData.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 /*
  32  * Interface for data for annotating a Phylogeny.
  33  */
  34 public interface PhylogenyData {
  35
  36     public StringBuffer asSimpleText();
  37
  38     public StringBuffer asText();
  39
  40     /**
  41      * Creates a new PhylogenyData object with identical values as this
  42      * PhylogenyData.
  43      * This ~should~ return a deep copy, but not there yet.
  44      *
  45      *
  46      * @return a ~deep~ copy of this PhylogenyData
  47      */
  48     public PhylogenyData copy();
  49
  50     /**
  51      * Compares this PhylogenyData to PhylogenyData data. In general, this
  52      * should return true if and only if all fiels are exactly identical.
  53      *
  54      * @param PhylogenyData
  55      *            the PhylogenyData to compare to
  56      * @return in general, true if and only if all fiels are exactly identical,
  57      *         false otherwise
  58      */
  59     public boolean isEqual( final PhylogenyData data );
  60
  61     public StringBuffer toNHX();
  62
  63     /**
  64      *  Writes a phyloXML representation of this phylogeny data.
  65      *
  66      * @param writer
  67      * @param level
  68      * @param indentation
  69      * @throws IOException
  70      */
  71     public void toPhyloXML( final Writer writer, final int level, final String indentation ) throws IOException;
  72 }