src/jalview/ws/dbsources/das/api/jalviewSourceI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.ws.dbsources.das.api;
  20
  21 import java.util.List;
  22
  23 import jalview.ws.seqfetcher.DbSourceProxy;
  24
  25 import org.biodas.jdas.schema.sources.MAINTAINER;
  26 import org.biodas.jdas.schema.sources.VERSION;
  27
  28 public interface jalviewSourceI
  29 {
  30
  31   String getTitle();
  32
  33   VERSION getVersion();
  34
  35   String getDocHref();
  36
  37   String getDescription();
  38
  39   String getUri();
  40
  41   MAINTAINER getMAINTAINER();
  42
  43   String getEmail();
  44
  45   boolean isLocal();
  46
  47   boolean isSequenceSource();
  48
  49   String[] getCapabilityList(VERSION v);
  50
  51   String[] getLabelsFor(VERSION v);
  52
  53   /**
  54    *
  55    * @return null if not a sequence source, otherwise a series of database
  56    *         sources that can be used to retrieve sequence data for particular
  57    *         database coordinate systems
  58    */
  59   List<DbSourceProxy> getSequenceSourceProxies();
  60
  61   boolean isFeatureSource();
  62
  63   /**
  64    * returns the base URL for the latest version of a source's DAS endpoint set
  65    *
  66    * @return
  67    */
  68   String getSourceURL();
  69
  70   /**
  71    * test to see if this source's latest version is older than the given source
  72    *
  73    * @param jalviewSourceI
  74    * @return true if newer than given source
  75    */
  76   boolean isNewerThan(jalviewSourceI jalviewSourceI);
  77
  78   /**
  79    * test if the source is a reference source for the authority
  80    * @return
  81    */
  82   boolean isReferenceSource();
  83
  84 }