X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Frest%2Fparams%2FSeqIdVector.java;h=05acb2376788b2934837396904cdd77b08ec1bde;hb=b2f9a8d7bce642ff4011bc6d49e02bb0569fbb11;hp=5f7c5519ee72aecdc93a2a3cdd51aac1c34e5500;hpb=231cba7c0cb9097957cd61ef96aab8e32e2d0337;p=jalview.git diff --git a/src/jalview/ws/rest/params/SeqIdVector.java b/src/jalview/ws/rest/params/SeqIdVector.java index 5f7c551..05acb23 100644 --- a/src/jalview/ws/rest/params/SeqIdVector.java +++ b/src/jalview/ws/rest/params/SeqIdVector.java @@ -1,44 +1,67 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1) + * Copyright (C) 2014 The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ package jalview.ws.rest.params; import jalview.datamodel.AlignmentI; import jalview.datamodel.SequenceI; +import jalview.ws.params.OptionI; +import jalview.ws.params.simple.Option; import jalview.ws.rest.InputType; import jalview.ws.rest.NoValidInputDataException; import jalview.ws.rest.RestJob; -import jalview.ws.rest.RestServiceDescription; -import jalview.ws.rest.InputType.molType; import java.io.UnsupportedEncodingException; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; -import java.util.regex.Matcher; -import java.util.regex.Pattern; import org.apache.http.entity.mime.content.ContentBody; import org.apache.http.entity.mime.content.StringBody; /** - * input a list of sequence IDs separated by some separator + * input a list of sequence IDs separated by some separator + * * @author JimP - * + * */ -public class SeqIdVector extends InputType { +public class SeqIdVector extends InputType +{ public SeqIdVector() { - super(new Class[] { AlignmentI.class} ); + super(new Class[] + { AlignmentI.class }); } /** * separator for list of sequence IDs - default is ',' */ - String sep=","; + String sep = ","; + molType type; + @Override - public ContentBody formatForInput(RestJob rj) throws UnsupportedEncodingException, NoValidInputDataException + public ContentBody formatForInput(RestJob rj) + throws UnsupportedEncodingException, NoValidInputDataException { StringBuffer idvector = new StringBuffer(); - boolean list=false; - for (SequenceI seq:rj.getSequencesForInput(token, type)) + boolean list = false; + for (SequenceI seq : rj.getSequencesForInput(token, type)) { if (list) { @@ -47,44 +70,65 @@ public class SeqIdVector extends InputType { idvector.append(seq.getName()); } return new StringBody(idvector.toString()); - } + } + @Override public List getURLEncodedParameter() { ArrayList prms = new ArrayList(); super.addBaseParams(prms); - prms.add("sep='"+ sep+"'"); - prms.add("type='"+type+"'"); + prms.add("sep='" + sep + "'"); + if (type != null) + { + prms.add("type='" + type + "'"); + } return prms; } + @Override public String getURLtokenPrefix() { return "SEQIDS"; } + @Override - public boolean configureProperty(String tok, String val, StringBuffer warnings) + public boolean configureProperty(String tok, String val, + StringBuffer warnings) { if (tok.startsWith("sep")) { - sep=val; + sep = val; return true; } if (tok.startsWith("type")) { - try { - type=molType.valueOf(val); + try + { + type = molType.valueOf(val); return true; } catch (Exception x) { - warnings.append("Invalid molecule type '"+val+"'. Must be one of ("); - for (molType v:molType.values()) + warnings.append("Invalid molecule type '" + val + + "'. Must be one of ("); + for (molType v : molType.values()) { - warnings.append(" "+v); + warnings.append(" " + v); } warnings.append(")\n"); } } return false; } + + @Override + public List getOptions() + { + List lst = getBaseOptions(); + lst.add(new Option("sep", + "Separator character between elements of vector", true, ",", + sep, Arrays.asList(new String[] + { " ", ",", ";", "\t", "|" }), null)); + lst.add(createMolTypeOption("type", "Sequence type", false, type, null)); + return lst; + } }