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.ssbind;
023
024import org.biojava.utils.stax.StAXContentHandler;
025
026/**
027 * <code>StAXHandlerFactory</code> is an interface for factories
028 * producing <code>StAXContentHandler</code>s which are used by the
029 * <code>SeqSimilarityStAXAdapter</code>.
030 *
031 * @author Thomas Down
032 * @author Keith James
033 * @since 1.3
034 */
035public interface StAXHandlerFactory
036{
037    /**
038     * <code>getHandler</code> returns an appropriate
039     * <code>StAXContentHandler</code> implementation containing a
040     * reference to a parent context.
041     *
042     * @param ssContext a <code>SeqSimilarityStAXAdapter</code>.
043     *
044     * @return a <code>StAXContentHandler</code>.
045     */
046    public StAXContentHandler getHandler(SeqSimilarityStAXAdapter ssContext);
047}