JAL-1807 explicit imports (jalview.renderer)
[jalview.git] / src / jalview / ws / rest / params / AnnotationFile.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.ws.rest.params;
22
23 import jalview.datamodel.AlignmentI;
24 import jalview.ws.params.OptionI;
25 import jalview.ws.params.simple.Option;
26 import jalview.ws.rest.InputType;
27 import jalview.ws.rest.NoValidInputDataException;
28 import jalview.ws.rest.RestJob;
29
30 import java.io.UnsupportedEncodingException;
31 import java.util.ArrayList;
32 import java.util.Arrays;
33 import java.util.List;
34
35 import org.apache.http.entity.mime.content.ContentBody;
36 import org.apache.http.entity.mime.content.StringBody;
37
38 /**
39  * format a jalview annotation file for input to a rest service.
40  * 
41  * @author JimP
42  * 
43  */
44 public class AnnotationFile extends InputType
45 {
46   public AnnotationFile()
47   {
48     super(new Class[]
49     { AlignmentI.class });
50   }
51
52   /**
53    * standard jalview annotation file
54    */
55   final String JVANNOT = "JalviewAnnotation";
56
57   /**
58    * export annotation row as simple csv
59    */
60   final String CSVANNOT = "CsvAnnotationRow";
61
62   /**
63    * format of annotation file
64    */
65   String format = JVANNOT;
66
67   // TODO verify annotation file format enumeration
68   @Override
69   public ContentBody formatForInput(RestJob rj)
70           throws UnsupportedEncodingException, NoValidInputDataException
71   {
72     AlignmentI al = rj.getAlignmentForInput(token, molType.MIX);
73     if (format.equals(JVANNOT))
74     {
75       return new StringBody(
76               new jalview.io.AnnotationFile()
77                       .printAnnotationsForAlignment(al));
78     }
79     else
80     {
81       if (!format.equals(CSVANNOT))
82       {
83         throw new UnsupportedEncodingException(
84                 "Unrecognised format for exporting Annotation (" + format
85                         + ")");
86       }
87       return new StringBody(
88               new jalview.io.AnnotationFile().printCSVAnnotations(al
89                       .getAlignmentAnnotation()));
90     }
91   }
92
93   @Override
94   public List<String> getURLEncodedParameter()
95   {
96     ArrayList<String> prms = new ArrayList<String>();
97     super.addBaseParams(prms);
98     prms.add("format='" + format + "'");
99     return prms;
100   }
101
102   @Override
103   public String getURLtokenPrefix()
104   {
105     return "ALANNOTATION";
106   }
107
108   @Override
109   public boolean configureProperty(String tok, String val,
110           StringBuffer warnings)
111   {
112
113     if (tok.startsWith("format"))
114     {
115       for (String fmt : new String[]
116       { CSVANNOT, JVANNOT })
117       {
118         if (val.equalsIgnoreCase(fmt))
119         {
120           format = fmt;
121           return true;
122         }
123       }
124       warnings.append("Invalid annotation file format '" + val
125               + "'. Must be one of (");
126       for (String fmt : new String[]
127       { CSVANNOT, JVANNOT })
128       {
129         warnings.append(" " + fmt);
130       }
131       warnings.append(")\n");
132     }
133     return false;
134   }
135
136   @Override
137   public List<OptionI> getOptions()
138   {
139     // TODO - consider disregarding base options here.
140     List<OptionI> lst = getBaseOptions();
141     lst.add(new Option("format", "Alignment annotation upload format",
142             true, JVANNOT, format, Arrays.asList(new String[]
143             { JVANNOT, CSVANNOT }), null));
144     return lst;
145   }
146 }