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.search;
023
024import org.biojava.bio.BioException;
025
026/**
027 * The <code>SearchBuilder</code> interface is to be used by objects
028 * which accumulate state via a <code>SearchContentHandler</code> and
029 * then construct a <code>SeqSimilaritySearchResult</code> object.
030 *
031 * @author Keith James
032 * @since 1.1
033 * @see SearchContentHandler
034 */
035public interface SearchBuilder extends SearchContentHandler
036{
037    /**
038     * The <code>makeSearchResult</code> method returns a
039     * <code>SeqSimilaritySearchResult</code> instance created from
040     * accumulated data.
041     *
042     * @return a <code>SeqSimilaritySearchResult</code>.
043     *
044     * @exception BioException if an error occurs.
045     */
046    public SeqSimilaritySearchResult makeSearchResult()
047        throws BioException;
048}