2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ 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
10 * of the License, or (at your option) any later version.
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.
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.
21 package jalview.ws.rest.params;
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.SequenceI;
25 import jalview.ws.params.OptionI;
26 import jalview.ws.params.simple.Option;
27 import jalview.ws.rest.InputType;
28 import jalview.ws.rest.NoValidInputDataException;
29 import jalview.ws.rest.RestJob;
31 import java.io.UnsupportedEncodingException;
32 import java.util.ArrayList;
33 import java.util.Arrays;
34 import java.util.List;
36 import org.apache.http.entity.mime.content.ContentBody;
37 import org.apache.http.entity.mime.content.StringBody;
40 * input a list of sequence IDs separated by some separator
45 public class SeqIdVector extends InputType
50 { AlignmentI.class });
54 * separator for list of sequence IDs - default is ','
61 public ContentBody formatForInput(RestJob rj)
62 throws UnsupportedEncodingException, NoValidInputDataException
64 StringBuffer idvector = new StringBuffer();
66 for (SequenceI seq : rj.getSequencesForInput(token, type))
72 idvector.append(seq.getName());
74 return new StringBody(idvector.toString());
78 public List<String> getURLEncodedParameter()
80 ArrayList<String> prms = new ArrayList<String>();
81 super.addBaseParams(prms);
82 prms.add("sep='" + sep + "'");
85 prms.add("type='" + type + "'");
91 public String getURLtokenPrefix()
97 public boolean configureProperty(String tok, String val,
98 StringBuffer warnings)
100 if (tok.startsWith("sep"))
105 if (tok.startsWith("type"))
109 type = molType.valueOf(val);
111 } catch (Exception x)
113 warnings.append("Invalid molecule type '" + val
114 + "'. Must be one of (");
115 for (molType v : molType.values())
117 warnings.append(" " + v);
119 warnings.append(")\n");
126 public List<OptionI> getOptions()
128 List<OptionI> lst = getBaseOptions();
129 lst.add(new Option("sep",
130 "Separator character between elements of vector", true, ",",
131 sep, Arrays.asList(new String[]
132 { " ", ",", ";", "\t", "|" }), null));
133 lst.add(createMolTypeOption("type", "Sequence type", false, type, null));