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

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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  */
  18 package jalview.ws.rest.params;
  19
  20 import jalview.datamodel.AlignmentI;
  21 import jalview.datamodel.SequenceI;
  22 import jalview.ws.params.OptionI;
  23 import jalview.ws.params.simple.Option;
  24 import jalview.ws.rest.InputType;
  25 import jalview.ws.rest.NoValidInputDataException;
  26 import jalview.ws.rest.RestJob;
  27
  28 import java.io.UnsupportedEncodingException;
  29 import java.util.ArrayList;
  30 import java.util.Arrays;
  31 import java.util.List;
  32
  33 import org.apache.http.entity.mime.content.ContentBody;
  34 import org.apache.http.entity.mime.content.StringBody;
  35
  36 /**
  37  * input a list of sequence IDs separated by some separator
  38  *
  39  * @author JimP
  40  *
  41  */
  42 public class SeqIdVector extends InputType
  43 {
  44   public SeqIdVector()
  45   {
  46     super(new Class[]
  47     { AlignmentI.class });
  48   }
  49
  50   /**
  51    * separator for list of sequence IDs - default is ','
  52    */
  53   String sep = ",";
  54
  55   molType type;
  56
  57   @Override
  58   public ContentBody formatForInput(RestJob rj)
  59           throws UnsupportedEncodingException, NoValidInputDataException
  60   {
  61     StringBuffer idvector = new StringBuffer();
  62     boolean list = false;
  63     for (SequenceI seq : rj.getSequencesForInput(token, type))
  64     {
  65       if (list)
  66       {
  67         idvector.append(sep);
  68       }
  69       idvector.append(seq.getName());
  70     }
  71     return new StringBody(idvector.toString());
  72   }
  73
  74   @Override
  75   public List<String> getURLEncodedParameter()
  76   {
  77     ArrayList<String> prms = new ArrayList<String>();
  78     super.addBaseParams(prms);
  79     prms.add("sep='" + sep + "'");
  80     if (type != null)
  81     {
  82       prms.add("type='" + type + "'");
  83     }
  84     return prms;
  85   }
  86
  87   @Override
  88   public String getURLtokenPrefix()
  89   {
  90     return "SEQIDS";
  91   }
  92
  93   @Override
  94   public boolean configureProperty(String tok, String val,
  95           StringBuffer warnings)
  96   {
  97     if (tok.startsWith("sep"))
  98     {
  99       sep = val;
 100       return true;
 101     }
 102     if (tok.startsWith("type"))
 103     {
 104       try
 105       {
 106         type = molType.valueOf(val);
 107         return true;
 108       } catch (Exception x)
 109       {
 110         warnings.append("Invalid molecule type '" + val
 111                 + "'. Must be one of (");
 112         for (molType v : molType.values())
 113         {
 114           warnings.append(" " + v);
 115         }
 116         warnings.append(")\n");
 117       }
 118     }
 119     return false;
 120   }
 121
 122   @Override
 123   public List<OptionI> getOptions()
 124   {
 125     List<OptionI> lst = getBaseOptions();
 126     lst.add(new Option("sep",
 127             "Separator character between elements of vector", true, ",",
 128             sep, Arrays.asList(new String[]
 129             { " ", ",", ";", "\t", "|" }), null));
 130     lst.add(createMolTypeOption("type", "Sequence type", false, type, null));
 131     return lst;
 132   }
 133 }