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 * Each HomologeneEntry represents a single
027 * Homologene record that relates two
028 * presumptive orthologues.
029 */
030public interface SimilarityType
031{
032    public final static SimilarityType MULTIPLE
033        = new PlaceHolder("reciprocal best match between 3 or more organisms");
034    public final static SimilarityType TWIN
035        = new PlaceHolder("reciprocal best match between 2 organisms");
036    public final static SimilarityType CURATED
037        = new PlaceHolder("curated homology relationship");
038
039    public class PlaceHolder implements SimilarityType
040    {
041        String description;
042
043        private PlaceHolder(String description)
044        {
045            this.description = description;
046        }
047
048        public String getDescription()
049        {
050            return description;
051        }
052    }
053}