src/jalview/urls/UrlProviderI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.urls;
  22
  23 import java.io.File;
  24 import java.util.Vector;
  25
  26 /**
  27  * Methods for providing consistent access to up-to-date URLs
  28  *
  29  * @author $author$
  30  * @version $Revision$
  31  */
  32 public interface UrlProviderI
  33 {
  34
  35   /*
  36    * Default sequence URL link label for EMBL-EBI search
  37    */
  38   public static final String DEFAULT_LABEL = "EMBL-EBI Search";
  39
  40   /*
  41    * Default sequence URL link string for EMBL-EBI search
  42    */
  43   public static final String DEFAULT_STRING = DEFAULT_LABEL
  44           + "|http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$";
  45
  46   /*
  47    * Location of file for identifiers.org download
  48    */
  49   public static final String ID_ORG_FILE = System.getProperty("user.home")
  50           + File.separatorChar + ".jalview_identifiers";
  51
  52   /**
  53    * Get names and urls in as strings for display
  54    *
  55    */
  56   Vector<String> getLinksForDisplay();
  57
  58   /**
  59    * Get the id of the default URL
  60    *
  61    * @return id of the default URL
  62    */
  63   String getDefaultUrl();
  64
  65   /**
  66    * Get the link for the default URL
  67    *
  68    * @seqid sequence id for which to build link
  69    * @return link for the default URL
  70    */
  71   String getDefaultUrl(String seqid);
  72
  73   /**
  74    * Get the target of thelink for the default URL
  75    *
  76    * @seqid sequence id for which to build link
  77    * @return target of link for the default URL
  78    */
  79   String getDefaultTarget(String seqid);
  80
  81   /**
  82    * Set the default URL
  83    *
  84    * @param id
  85    *          the id of the URL to set as default
  86    * @return true if setting was successful, false otherwise
  87    */
  88   boolean setDefaultUrl(String id);
  89
  90   /**
  91    * Write out all URLs as a string suitable for serialising
  92    *
  93    * @return string representation of available URLs
  94    */
  95   String writeUrlsAsString();
  96
  97   /**
  98    * Set URL links from pair of collections
  99    *
 100    * @param names
 101    * @param urls
 102    */
 103   void setUrlLinks(Vector<String> names, Vector<String> urls)
 104           throws IllegalArgumentException;
 105
 106   /**
 107    * Choose the default URL in the event of the selected default being
 108    * unavailable
 109    *
 110    * @return id of chosen default url
 111    */
 112   String chooseDefaultUrl();
 113 }