001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022package org.biojava.bio.program.homologene;
023
024
025/**
026 * this entry contains data about the orthologue.
027 */
028public interface Orthologue
029{
030    /**
031     * return the title used by Genbank for this protein
032     */
033    public String getTitle();
034
035    /**
036     * return the Taxon associated with this orthologue
037     */
038    public Taxon getTaxon();
039
040    /**
041     * a convenience method to return the TaxonID for thsi orhtologue.
042     */
043    public int getTaxonID();
044
045    /**
046     * get the locus ID associated with this orthologue.
047     * It can be null.
048     */
049    public String getLocusID();
050
051    /**
052     * get the Homologene ID.  This is unique and
053     * always defined.
054     */
055    public String getHomologeneID();
056
057    /**
058     * get the Accession ID associated with this orthologue.
059     */
060    public String getAccession();
061
062    public void setTitle(String title);
063}