X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Frest%2Fparams%2FAlignment.java;h=0aee4cd03b7c4ec825605ca225c66c8f44d271c3;hb=c19d2a91ca05e052e3408bf5852d88eb5d0608f1;hp=922f933a0146f22707860339c77b8faaae7562a3;hpb=f5d48464f668eb2ffd8f6cdcd0d04ff5658c54fc;p=jalview.git diff --git a/src/jalview/ws/rest/params/Alignment.java b/src/jalview/ws/rest/params/Alignment.java index 922f933..0aee4cd 100644 --- a/src/jalview/ws/rest/params/Alignment.java +++ b/src/jalview/ws/rest/params/Alignment.java @@ -1,10 +1,32 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2) + * Copyright (C) 2015 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.ws.params.OptionI; +import jalview.ws.params.simple.BooleanOption; +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.InputType.molType; import java.io.BufferedOutputStream; import java.io.File; @@ -12,7 +34,9 @@ import java.io.FileOutputStream; import java.io.OutputStreamWriter; import java.io.PrintWriter; import java.io.UnsupportedEncodingException; -import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; import org.apache.http.entity.mime.content.ContentBody; import org.apache.http.entity.mime.content.FileBody; @@ -20,42 +44,163 @@ import org.apache.http.entity.mime.content.StringBody; /** * format an alignment for input to rest service. + * * @author JimP - * + * */ -public class Alignment extends InputType { +public class Alignment extends InputType +{ public Alignment() { - super(new Class[] { AlignmentI.class} ); + super(new Class[] { AlignmentI.class }); } - String format="FASTA"; + String format = "FASTA"; + molType type; - boolean jvsuffix=false; + + boolean jvsuffix = false; + /** * input data as a file upload rather than inline content */ - public boolean writeAsFile; + public boolean writeAsFile = false; + + @Override + public ContentBody formatForInput(RestJob rj) + throws UnsupportedEncodingException, NoValidInputDataException + { + AlignmentI alignment = rj.getAlignmentForInput(token, type); + if (writeAsFile) + { + try + { + File fa = File.createTempFile("jvmime", ".fa"); + PrintWriter pw = new PrintWriter( + new OutputStreamWriter(new BufferedOutputStream( + new FileOutputStream(fa)), "UTF-8")); + pw.append(new jalview.io.FormatAdapter().formatSequences(format, + alignment, jvsuffix)); + pw.close(); + return new FileBody(fa, "text/plain"); + } catch (Exception ex) + { + throw new NoValidInputDataException( + "Couldn't write out alignment to file.", ex); + } + } + else + { + jalview.io.FormatAdapter fa = new jalview.io.FormatAdapter(); + fa.setNewlineString("\r\n"); + return new StringBody( + (fa.formatSequences(format, alignment, jvsuffix))); + // , + // "text/plain",Charset.forName("UTF-8")); + // , "text/plain", Charset.forName("UTF-8")); + // sb.getContentTypeParameters().put("filename", "alignment.fa"); + } + } + @Override - public ContentBody formatForInput(RestJob rj) throws UnsupportedEncodingException, NoValidInputDataException + public List getURLEncodedParameter() { - AlignmentI alignment = rj.getAlignmentForInput(token,type); + ArrayList prms = new ArrayList(); + prms.add("format='" + format + "'"); + if (type != null) + { + prms.add("type='" + type.toString() + "'"); + } + if (jvsuffix) + { + prms.add("jvsuffix"); + } + ; if (writeAsFile) { - try { - File fa = File.createTempFile("jvmime", ".fa"); - PrintWriter pw = new PrintWriter(new OutputStreamWriter(new BufferedOutputStream(new FileOutputStream(fa)), "UTF-8")); - pw.append(new jalview.io.FormatAdapter().formatSequences(format, alignment, jvsuffix)); - pw.close(); - return new FileBody(fa, "text/plain"); - } catch (Exception ex) + prms.add("writeasfile"); + } + ; + return prms; + } + + @Override + public String getURLtokenPrefix() + { + return "ALIGNMENT"; + } + + @Override + public boolean configureProperty(String tok, String val, + StringBuffer warnings) + { + if (tok.startsWith("jvsuffix")) + { + jvsuffix = true; + return true; + } + if (tok.startsWith("writeasfile")) + { + writeAsFile = true; + return true; + } + + if (tok.startsWith("format")) { - throw new NoValidInputDataException("Couldn't write out alignment to file.",ex); + for (String fmt : jalview.io.FormatAdapter.WRITEABLE_FORMATS) + { + if (val.equalsIgnoreCase(fmt)) + { + format = fmt; + return true; + } + } + warnings.append("Invalid alignment format '" + val + + "'. Must be one of ("); + for (String fmt : jalview.io.FormatAdapter.WRITEABLE_FORMATS) + { + warnings.append(" " + fmt); + } + warnings.append(")\n"); } - } else { - StringBody sb = new StringBody(new jalview.io.FormatAdapter().formatSequences(format, alignment, jvsuffix)); // , "text/plain", Charset.forName("UTF-8")); - // sb.getContentTypeParameters().put("filename", "alignment.fa"); - return sb; + if (tok.startsWith("type")) + { + 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(" " + v); + } + warnings.append(")\n"); + } } + return false; + } + + @Override + public List getOptions() + { + List lst = getBaseOptions(); + lst.add(new BooleanOption("jvsuffix", + "Append jalview style /start-end suffix to ID", false, false, + jvsuffix, null)); + lst.add(new BooleanOption("writeasfile", + "Append jalview style /start-end suffix to ID", false, false, + writeAsFile, null)); + + lst.add(new Option("format", "Alignment upload format", true, "FASTA", + format, Arrays + .asList(jalview.io.FormatAdapter.WRITEABLE_FORMATS), + null)); + lst.add(createMolTypeOption("type", "Sequence type", false, type, null)); + + return lst; } -} \ No newline at end of file + +}