src/jalview/ws/rest/params/Tree.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
   3  * Copyright (C) 2014 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[]
  45     { jalview.analysis.NJTree.class });
  46   }
  47
  48   // TODO specify modifiers for tree output format
  49   @Override
  50   public ContentBody formatForInput(RestJob rj)
  51           throws UnsupportedEncodingException
  52   {
  53     // TODO: implement tree inputType
  54     /*
  55      * rj.getTreeForInput(token); return new StringBody(new )
  56      */
  57     throw new Error(MessageManager.getString("error.tree_inputtype_not_yet_implemented"));
  58     // return null;
  59   }
  60
  61   public String getURLtokenPrefix()
  62   {
  63     return "NEWICK";
  64   }
  65
  66   @Override
  67   public List<String> getURLEncodedParameter()
  68   {
  69     ArrayList<String> prms = new ArrayList<String>();
  70     super.addBaseParams(prms);
  71     return prms;
  72   }
  73
  74   @Override
  75   public boolean configureProperty(String tok, String val,
  76           StringBuffer warnings)
  77   {
  78     return true;
  79   }
  80
  81   @Override
  82   public List<OptionI> getOptions()
  83   {
  84     return getBaseOptions();
  85   }
  86
  87 }