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
024import org.biojava.utils.ChangeVetoException;
025
026/**
027 * Interface for a Set of OrthoPairSets
028 *
029 * @author David Huen
030 */
031public interface OrthoPairCollection
032{
033
034    /**
035     * Iterator for a OrthoPairCollection
036     */
037    public interface Iterator
038    {
039        /**
040         * are more OrthoPairSets available?
041         */
042        public boolean hasNext();
043
044        /**
045         * returns the next OrthoPairSet
046         */
047        public OrthoPairSet nextSet();
048    }
049
050
051    public void add(OrthoPairSet group) throws ChangeVetoException;
052
053    public boolean contains(OrthoPairSet group);
054
055    public boolean isEmpty();
056
057    public Iterator iterator();
058
059    public OrthoPairCollection filter(OrthoPairSetFilter filters);
060}
061