X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Frest%2Fparams%2FAnnotationFile.java;h=0268c3509aae8ff914fa44aa356a749bbdb7bc98;hb=8ba93f7655ea7165579539158b6a5eb076135bba;hp=b05b4eddcae7dd66df481a21efbae41d1ed8b077;hpb=a45774ee31d9f35d4eff46d54d7deab719afb092;p=jalview.git diff --git a/src/jalview/ws/rest/params/AnnotationFile.java b/src/jalview/ws/rest/params/AnnotationFile.java index b05b4ed..0268c35 100644 --- a/src/jalview/ws/rest/params/AnnotationFile.java +++ b/src/jalview/ws/rest/params/AnnotationFile.java @@ -1,20 +1,23 @@ -/******************************************************************************* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) - * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle - * +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) + * 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. - * + * 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 . - *******************************************************************************/ + * + * 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; @@ -23,8 +26,6 @@ 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; @@ -36,55 +37,75 @@ import org.apache.http.entity.mime.content.StringBody; /** * format a jalview annotation file for input to a rest service. + * * @author JimP - * + * */ -public class AnnotationFile extends InputType { +public class AnnotationFile extends InputType +{ public AnnotationFile() { - super(new Class[] { AlignmentI.class} ); + super(new Class[] + { AlignmentI.class }); } + /** * standard jalview annotation file */ - final String JVANNOT="JalviewAnnotation"; + final String JVANNOT = "JalviewAnnotation"; + /** * export annotation row as simple csv */ - final String CSVANNOT="CsvAnnotationRow"; + final String CSVANNOT = "CsvAnnotationRow"; + /** * format of annotation file */ - String format=JVANNOT; + String format = JVANNOT; + // TODO verify annotation file format enumeration @Override - public ContentBody formatForInput(RestJob rj) throws UnsupportedEncodingException, NoValidInputDataException + public ContentBody formatForInput(RestJob rj) + throws UnsupportedEncodingException, NoValidInputDataException { - AlignmentI al = rj.getAlignmentForInput(token,molType.MIX); + AlignmentI al = rj.getAlignmentForInput(token, molType.MIX); if (format.equals(JVANNOT)) - {return new StringBody(new jalview.io.AnnotationFile().printAnnotations(al.getAlignmentAnnotation(), - al.getGroups(),al.getProperties())); - } else { - if (!format.equals(CSVANNOT)) - { - throw new UnsupportedEncodingException("Unrecognised format for exporting Annotation ("+format+")"); - } - return new StringBody(new jalview.io.AnnotationFile().printCSVAnnotations(al.getAlignmentAnnotation())); + { + return new StringBody( + new jalview.io.AnnotationFile().printAnnotations( + al.getAlignmentAnnotation(), al.getGroups(), + al.getProperties())); + } + else + { + if (!format.equals(CSVANNOT)) + { + throw new UnsupportedEncodingException( + "Unrecognised format for exporting Annotation (" + format + + ")"); } + return new StringBody( + new jalview.io.AnnotationFile().printCSVAnnotations(al + .getAlignmentAnnotation())); + } } + @Override public List getURLEncodedParameter() { ArrayList prms = new ArrayList(); super.addBaseParams(prms); - prms.add("format='"+format+"'"); - return prms; + prms.add("format='" + format + "'"); + return prms; } + @Override public String getURLtokenPrefix() { return "ALANNOTATION"; } + @Override public boolean configureProperty(String tok, String val, StringBuffer warnings) @@ -92,7 +113,8 @@ public class AnnotationFile extends InputType { if (tok.startsWith("format")) { - for (String fmt : new String[] { CSVANNOT, JVANNOT}) + for (String fmt : new String[] + { CSVANNOT, JVANNOT }) { if (val.equalsIgnoreCase(fmt)) { @@ -102,7 +124,8 @@ public class AnnotationFile extends InputType { } warnings.append("Invalid annotation file format '" + val + "'. Must be one of ("); - for (String fmt : new String[] { CSVANNOT, JVANNOT}) + for (String fmt : new String[] + { CSVANNOT, JVANNOT }) { warnings.append(" " + fmt); } @@ -110,15 +133,15 @@ public class AnnotationFile extends InputType { } return false; } + @Override public List getOptions() { // TODO - consider disregarding base options here. List lst = getBaseOptions(); - lst.add(new Option("format", - "Alignment annotation upload format", true, JVANNOT, - format, Arrays.asList(new String[] - { JVANNOT, CSVANNOT}), null)); + lst.add(new Option("format", "Alignment annotation upload format", + true, JVANNOT, format, Arrays.asList(new String[] + { JVANNOT, CSVANNOT }), null)); return lst; } }