From e345d5ddc35a0772ac52962555b23cc8024c6168 Mon Sep 17 00:00:00 2001 From: gmungoc Date: Fri, 26 Apr 2019 14:53:42 +0100 Subject: [PATCH] JAL-2743 class Javadoc --- src/jalview/ext/ensembl/EnsemblMap.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/jalview/ext/ensembl/EnsemblMap.java b/src/jalview/ext/ensembl/EnsemblMap.java index f01bd4f..b1c9d86 100644 --- a/src/jalview/ext/ensembl/EnsemblMap.java +++ b/src/jalview/ext/ensembl/EnsemblMap.java @@ -19,6 +19,18 @@ import org.json.simple.JSONObject; import org.json.simple.parser.JSONParser; import org.json.simple.parser.ParseException; +/** + * A client for the Ensembl REST service /map endpoint, to convert from + * coordinates of one genome assembly to another. + *

+ * Note that species and assembly identifiers passed to this class must be valid + * in Ensembl. They are not case sensitive. + * + * @author gmcarstairs + * @see https://rest.ensembl.org/documentation/info/assembly_map + * @see https://rest.ensembl.org/info/assembly/human?content-type=text/xml + * @see https://rest.ensembl.org/info/species?content-type=text/xml + */ public class EnsemblMap extends EnsemblRestClient { private static final String MAPPED = "mapped"; -- 1.7.10.2