forester/java/src/org/forester/msa/Msa.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: https://sites.google.com/site/cmzmasek/home/software/forester
  25
  26 package org.forester.msa;
  27
  28 import java.io.IOException;
  29 import java.io.Writer;
  30 import java.util.List;
  31
  32 import org.forester.sequence.MolecularSequence;
  33 import org.forester.sequence.MolecularSequence.TYPE;
  34
  35 public interface Msa {
  36
  37     public static enum MSA_FORMAT {
  38         FASTA, PHYLIP, NEXUS;
  39     }
  40
  41     public String getIdentifier( int row );
  42
  43     public void setIdentifier( int row, String identifier );
  44
  45     public int getLength();
  46
  47     public int getNumberOfSequences();
  48
  49     public char getResidueAt( int row, int col );
  50
  51     public boolean isGapAt( int row, int col );
  52
  53     public List<Character> getColumnAt( int col );
  54
  55     public MolecularSequence getSequence( final String id );
  56
  57     public MolecularSequence getSequence( final int row );
  58
  59     public List<MolecularSequence> asSequenceList();
  60
  61     public StringBuffer getSequenceAsString( int row );
  62
  63     public abstract TYPE getType();
  64
  65     public void setResidueAt( final int row, final int col, final char residue );
  66
  67     public void write( Writer w, MSA_FORMAT format ) throws IOException;
  68 }