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

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.ws.rest.params;
  20
  21 import jalview.ws.params.OptionI;
  22 import jalview.ws.rest.InputType;
  23 import jalview.ws.rest.RestJob;
  24
  25 import java.io.UnsupportedEncodingException;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28
  29 import org.apache.http.entity.mime.content.ContentBody;
  30
  31 /**
  32  * format a tree for input to a rest service
  33  *
  34  * @author JimP
  35  *
  36  */
  37 public class Tree extends InputType
  38 {
  39   public Tree()
  40   {
  41     super(new Class[]
  42     { jalview.analysis.NJTree.class });
  43   }
  44
  45   // TODO specify modifiers for tree output format
  46   @Override
  47   public ContentBody formatForInput(RestJob rj)
  48           throws UnsupportedEncodingException
  49   {
  50     // TODO: implement tree inputType
  51     /*
  52      * rj.getTreeForInput(token); return new StringBody(new )
  53      */
  54     throw new Error("Tree InputType not yet implemented");
  55     // return null;
  56   }
  57
  58   public String getURLtokenPrefix()
  59   {
  60     return "NEWICK";
  61   }
  62
  63   @Override
  64   public List<String> getURLEncodedParameter()
  65   {
  66     ArrayList<String> prms = new ArrayList<String>();
  67     super.addBaseParams(prms);
  68     return prms;
  69   }
  70
  71   @Override
  72   public boolean configureProperty(String tok, String val,
  73           StringBuffer warnings)
  74   {
  75     return true;
  76   }
  77
  78   @Override
  79   public List<OptionI> getOptions()
  80   {
  81     return getBaseOptions();
  82   }
  83
  84 }