forester/java/src/org/forester/protein/Protein.java

   1 // $Id:
   2 //
   3 // FORESTER -- software libraries and applications
   4 // for evolutionary biology research and applications.
   5 //
   6 // Copyright (C) 2008-2009 Christian M. Zmasek
   7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   8 // All rights reserved
   9 //
  10 // This library is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU Lesser General Public
  12 // License as published by the Free Software Foundation; either
  13 // version 2.1 of the License, or (at your option) any later version.
  14 //
  15 // This library is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 // Lesser General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU Lesser General Public
  21 // License along with this library; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  23 //
  24 // Contact: phylosoft @ gmail . com
  25 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  26
  27 package org.forester.protein;
  28
  29 import java.util.List;
  30
  31 import org.forester.species.Species;
  32
  33 public interface Protein {
  34
  35     public void addProteinDomain( final Domain protein_domain );
  36
  37     /**
  38      * If in_nc_order is set to true, this should return true only and only if
  39      * the order in List 'domains' and this protein (as determined by the start positions
  40      * of the domains of this proteins, _not_ by their index) are the same
  41      * (interspersing, 'other', domains in this are ignored).
  42      * If in_nc_order is set to false, this should return true only and only if
  43      * this contains all domains listed in 'domains' (order and count do not matter).
  44      *
  45      * @param domains a list of domain ids in a certain order.
  46      * @param in_nc_order to consider order
  47      * @return
  48      */
  49     public boolean contains( final List<String> domains, final boolean in_nc_order );
  50
  51     public String getAccession();
  52
  53     public String getDescription();
  54
  55     public String getName();
  56
  57     public int getNumberOfProteinDomains();
  58
  59     public Domain getProteinDomain( final int index );
  60
  61     public int getProteinDomainCount( final String domain_id );
  62
  63     public List<Domain> getProteinDomains();
  64
  65     public List<Domain> getProteinDomains( final String domain_id );
  66
  67     public ProteinId getProteinId();
  68
  69     public int getLength();
  70
  71     public Species getSpecies();
  72
  73     public List<Domain> getDomainsSortedByPosition();
  74
  75     public String toDomainArchitectureString( final String separator, final double ie_cutoff );
  76
  77 }