2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.util.Vector;
26 * Methods for providing consistent access to up-to-date URLs
31 public interface UrlProviderI
35 * Default sequence URL link label for EMBL-EBI search
37 public static final String DEFAULT_LABEL = "EMBL-EBI Search";
40 * Default sequence URL link string for EMBL-EBI search
42 public static final String DEFAULT_STRING = DEFAULT_LABEL
43 + "|http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$";
46 * Get names and urls in as strings for display
49 Vector<String> getLinksForDisplay();
52 * Get the id of the default URL
54 * @return id of the default URL
56 String getDefaultUrl();
59 * Get the link for the default URL
61 * @seqid sequence id for which to build link
62 * @return link for the default URL
64 String getDefaultUrl(String seqid);
67 * Get the target of thelink for the default URL
69 * @seqid sequence id for which to build link
70 * @return target of link for the default URL
72 String getDefaultTarget(String seqid);
78 * the id of the URL to set as default
79 * @return true if setting was successful, false otherwise
81 boolean setDefaultUrl(String id);
84 * Write out all URLs as a string suitable for serialising
86 * @return string representation of available URLs
88 String writeUrlsAsString();
91 * Set URL links from pair of collections
96 void setUrlLinks(Vector<String> names, Vector<String> urls)
97 throws IllegalArgumentException;
100 * Choose the default URL in the event of the selected default being
103 * @return id of chosen default url
105 String chooseDefaultUrl();