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.util.MessageManager;
  24 import jalview.ws.params.OptionI;
  25 import jalview.ws.rest.InputType;
  26 import jalview.ws.rest.RestJob;
  27
  28 import java.io.UnsupportedEncodingException;
  29 import java.util.ArrayList;
  30 import java.util.List;
  31
  32 import org.apache.http.entity.mime.content.ContentBody;
  33
  34 /**
  35  * format a tree for input to a rest service
  36  *
  37  * @author JimP
  38  *
  39  */
  40 public class Tree extends InputType
  41 {
  42   public Tree()
  43   {
  44     super(new Class[] { jalview.analysis.NJTree.class });
  45   }
  46
  47   // TODO specify modifiers for tree output format
  48   @Override
  49   public ContentBody formatForInput(RestJob rj)
  50           throws UnsupportedEncodingException
  51   {
  52     // TODO: implement tree inputType
  53     /*
  54      * rj.getTreeForInput(token); return new StringBody(new )
  55      */
  56     throw new Error(
  57             MessageManager
  58                     .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 }