2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
19 package jalview.ws.rest.params;
21 import jalview.datamodel.AlignmentI;
22 import jalview.datamodel.SequenceI;
23 import jalview.ws.params.OptionI;
24 import jalview.ws.params.simple.Option;
25 import jalview.ws.rest.InputType;
26 import jalview.ws.rest.NoValidInputDataException;
27 import jalview.ws.rest.RestJob;
29 import java.io.UnsupportedEncodingException;
30 import java.util.ArrayList;
31 import java.util.Arrays;
32 import java.util.List;
34 import org.apache.http.entity.mime.content.ContentBody;
35 import org.apache.http.entity.mime.content.StringBody;
38 * input a list of sequence IDs separated by some separator
43 public class SeqIdVector extends InputType
48 { AlignmentI.class });
52 * separator for list of sequence IDs - default is ','
59 public ContentBody formatForInput(RestJob rj)
60 throws UnsupportedEncodingException, NoValidInputDataException
62 StringBuffer idvector = new StringBuffer();
64 for (SequenceI seq : rj.getSequencesForInput(token, type))
70 idvector.append(seq.getName());
72 return new StringBody(idvector.toString());
76 public List<String> getURLEncodedParameter()
78 ArrayList<String> prms = new ArrayList<String>();
79 super.addBaseParams(prms);
80 prms.add("sep='" + sep + "'");
83 prms.add("type='" + type + "'");
89 public String getURLtokenPrefix()
95 public boolean configureProperty(String tok, String val,
96 StringBuffer warnings)
98 if (tok.startsWith("sep"))
103 if (tok.startsWith("type"))
107 type = molType.valueOf(val);
109 } catch (Exception x)
111 warnings.append("Invalid molecule type '" + val
112 + "'. Must be one of (");
113 for (molType v : molType.values())
115 warnings.append(" " + v);
117 warnings.append(")\n");
124 public List<OptionI> getOptions()
126 List<OptionI> lst = getBaseOptions();
127 lst.add(new Option("sep",
128 "Separator character between elements of vector", true, ",",
129 sep, Arrays.asList(new String[]
130 { " ", ",", ";", "\t", "|" }), null));
131 lst.add(createMolTypeOption("type", "Sequence type", false, type, null));