JAL-1807 explicit imports (jalview.ws.*)
[jalview.git] / src / jalview / ws / rest / params / Tree.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.analysis.NJTree;
24 import jalview.util.MessageManager;
25 import jalview.ws.params.OptionI;
26 import jalview.ws.rest.InputType;
27 import jalview.ws.rest.RestJob;
28
29 import java.io.UnsupportedEncodingException;
30 import java.util.ArrayList;
31 import java.util.List;
32
33 import org.apache.http.entity.mime.content.ContentBody;
34
35 /**
36  * format a tree for input to a rest service
37  * 
38  * @author JimP
39  * 
40  */
41 public class Tree extends InputType
42 {
43   public Tree()
44   {
45     super(new Class[]
46     { NJTree.class });
47   }
48
49   // TODO specify modifiers for tree output format
50   @Override
51   public ContentBody formatForInput(RestJob rj)
52           throws UnsupportedEncodingException
53   {
54     // TODO: implement tree inputType
55     /*
56      * rj.getTreeForInput(token); return new StringBody(new )
57      */
58     throw new Error(MessageManager.getString("error.tree_inputtype_not_yet_implemented"));
59     // return null;
60   }
61
62   public String getURLtokenPrefix()
63   {
64     return "NEWICK";
65   }
66
67   @Override
68   public List<String> getURLEncodedParameter()
69   {
70     ArrayList<String> prms = new ArrayList<String>();
71     super.addBaseParams(prms);
72     return prms;
73   }
74
75   @Override
76   public boolean configureProperty(String tok, String val,
77           StringBuffer warnings)
78   {
79     return true;
80   }
81
82   @Override
83   public List<OptionI> getOptions()
84   {
85     return getBaseOptions();
86   }
87
88 }