JAL-2533 update javadoc
[jalview.git] / src / jalview / ext / ensembl / EnsemblGenomes.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.ext.ensembl;
22
23 /**
24  * A class to behave much like EnsemblGene but referencing the ensemblgenomes
25  * domain and data
26  * 
27  * @author gmcarstairs
28  *
29  */
30 public class EnsemblGenomes extends EnsemblGene
31 {
32   /**
33    * Constructor sets domain to rest.ensemblgenomes.org instead of the 'usual'
34    * rest.ensembl.org
35    */
36   public EnsemblGenomes()
37   {
38     super(ENSEMBL_GENOMES_REST);
39   }
40
41   @Override
42   public boolean isGeneIdentifier(String query)
43   {
44     return true;
45   }
46
47   @Override
48   public String getDbName()
49   {
50     return "EnsemblGenomes";
51   }
52
53   @Override
54   public String getTestQuery()
55   {
56     return "DDB_G0283883";
57   }
58
59   @Override
60   public String getDbSource()
61   {
62     return "EnsemblGenomes";
63   }
64
65 }