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.directory;
023
024import java.util.Map;
025
026import org.biojava.bio.BioException;
027import org.biojava.bio.seq.db.SequenceDBLite;
028
029/**
030 * Interfaces for named resources that can provide sequences via a
031 * database given some configuration information as defined by the
032 * OBDA standard.
033 *
034 * @author Thomas Down
035 * @author Keith James
036 * @author Matthew Pocock
037 */
038public interface SequenceDBProvider {
039    /**
040     * The name of this provider.
041     *
042     * @return the provider's name.
043     */
044    public String getName();
045    
046    /**
047     * Get a sequence database.
048     *
049     * @param config a Map containing key-value pairs identifying the
050     * database to resolve.
051     * @return a SequenceDBLite that was resolved.
052     */
053    public SequenceDBLite getSequenceDB(Map config)
054        throws RegistryException, BioException;
055}