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.phred;
023
024import org.biojava.bio.symbol.Symbol;
025import org.biojava.bio.symbol.SymbolList;
026
027/**
028 * <p>Qualitative is an interface for classes wanting to hold quality
029 * data in symbolic form such as Phred scores.<p>
030 *
031 * <p>Copyright (c) 2001</p>
032 * <p>Company:      AgResearch</p>
033 *
034 * @author Mark Schreiber
035 * @since 1.1
036 */
037
038public interface Qualitative {
039
040  /**
041   * Retreives the list of quality symbols from the underlying object.
042   */
043  SymbolList getQuality();
044
045  /**
046   * Retreives the quality symbol for the specified index.
047   * @param index - Must be greater than zero.
048   * @throws IndexOutOfBoundsException if index is outside of the quality symbol list.
049   */
050  Symbol getQualityAt(int index) throws IndexOutOfBoundsException;
051}