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 */
021package org.biojava.bio.program.blast2html;
022
023import java.util.Properties;
024/**
025 * Takes a database ID and some configuration properties
026 * ( such as base URL ) and returns either a URL or 
027 * a full anchor tag.
028 *
029 *
030 * Primary author -
031 *                 Colin Hardman      (CAT)
032 * Other authors  -
033 *                 Tim Dilks          (CAT)
034 *                 Simon Brocklehurst (CAT)
035 *                 Stuart Johnston    (CAT)
036 *                 Lawerence Bower    (CAT)
037 *                 Derek Crockford    (CAT)
038 *                 Neil Benn          (CAT)
039 *
040 * Copyright 2001 Cambridge Antibody Technology Group plc.
041 *
042 * This code released to the biojava project, May 2001
043 * under the LGPL license.
044 *
045 * @author Cambridge Antibody Technology Group plc
046 * @version 1.0
047 */
048public interface DatabaseURLGenerator {
049
050    /**
051     * Returns a string representation of a URL to the 
052     * specified ID. Used in summary section.
053     *
054     * @param poID a database ID
055     * @param poOptions <code>Properties</code> - any options needed
056     * @return a <code>String</code> value
057     */
058    String toURL( String poID, Properties poOptions );
059    /**
060     * Returns a full <a href=_____>retrieve item</a> anchor
061     * for the given database id. Used in detail section.
062     *
063     * @param poID a <code>String</code> value
064     * @param poOptions a <code>Properties</code> value
065     * @return a <code>String</code> value
066     */
067    String toLink( String poID, Properties poOptions );
068}