src/jalview/ext/paradise/Annotate3D.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.ext.paradise;
  22
  23 import jalview.ws.HttpClientUtils;
  24
  25 import java.io.IOException;
  26 import java.io.InputStreamReader;
  27 import java.io.Reader;
  28 import java.io.StringReader;
  29 import java.net.URL;
  30 import java.util.ArrayList;
  31 import java.util.Collection;
  32 import java.util.Iterator;
  33 import java.util.List;
  34
  35 import org.apache.http.NameValuePair;
  36 import org.apache.http.message.BasicNameValuePair;
  37 import org.json.simple.JSONArray;
  38 import org.json.simple.JSONObject;
  39 import org.json.simple.JSONStreamAware;
  40 import org.json.simple.parser.ContentHandler;
  41 import org.json.simple.parser.ParseException;
  42
  43 /**
  44  * simple methods for calling the various paradise RNA tools
  45  *
  46  * @author jimp
  47  *
  48  *         History: v1.0 revised from original due to refactoring of
  49  *         paradise-ubmc.u-strasbg.fr/webservices/annotate3d to
  50  *         http://arn-ibmc.in2p3.fr/api/compute/2d?tool=rnaview
  51  */
  52 public class Annotate3D
  53 {
  54   private static String twoDtoolsURL = "http://arn-ibmc.in2p3.fr/api/compute/2d";
  55
  56   private static ContentHandler createContentHandler()
  57   {
  58     ContentHandler ch = new ContentHandler()
  59     {
  60
  61       @Override
  62       public void startJSON() throws ParseException, IOException
  63       {
  64         // TODO Auto-generated method stub
  65
  66       }
  67
  68       @Override
  69       public void endJSON() throws ParseException, IOException
  70       {
  71         // TODO Auto-generated method stub
  72
  73       }
  74
  75       @Override
  76       public boolean startObject() throws ParseException, IOException
  77       {
  78         // TODO Auto-generated method stub
  79         return false;
  80       }
  81
  82       @Override
  83       public boolean endObject() throws ParseException, IOException
  84       {
  85         // TODO Auto-generated method stub
  86         return false;
  87       }
  88
  89       @Override
  90       public boolean startObjectEntry(String key) throws ParseException,
  91               IOException
  92       {
  93         // TODO Auto-generated method stub
  94         return false;
  95       }
  96
  97       @Override
  98       public boolean endObjectEntry() throws ParseException, IOException
  99       {
 100         // TODO Auto-generated method stub
 101         return false;
 102       }
 103
 104       @Override
 105       public boolean startArray() throws ParseException, IOException
 106       {
 107         // TODO Auto-generated method stub
 108         return false;
 109       }
 110
 111       @Override
 112       public boolean endArray() throws ParseException, IOException
 113       {
 114         // TODO Auto-generated method stub
 115         return false;
 116       }
 117
 118       @Override
 119       public boolean primitive(Object value) throws ParseException,
 120               IOException
 121       {
 122         // TODO Auto-generated method stub
 123         return false;
 124       }
 125
 126     };
 127     return ch;
 128   }
 129
 130   public static Iterator<Reader> getRNAMLForPDBFileAsString(String pdbfile)
 131           throws Exception
 132   {
 133     List<NameValuePair> vals = new ArrayList<NameValuePair>();
 134     vals.add(new BasicNameValuePair("tool", "rnaview"));
 135     vals.add(new BasicNameValuePair("data", pdbfile));
 136     vals.add(new BasicNameValuePair("output", "rnaml"));
 137     // return processJsonResponseFor(HttpClientUtils.doHttpUrlPost(twoDtoolsURL,
 138     // vals));
 139     ArrayList<Reader> readers = new ArrayList<Reader>();
 140     readers.add(HttpClientUtils.doHttpUrlPost(twoDtoolsURL, vals));
 141     return readers.iterator();
 142
 143   }
 144
 145   public static Iterator<Reader> processJsonResponseFor(Reader respons)
 146           throws Exception
 147   {
 148     org.json.simple.parser.JSONParser jp = new org.json.simple.parser.JSONParser();
 149     try
 150     {
 151       final JSONArray responses = (JSONArray) jp.parse(respons);
 152       final Iterator rvals = responses.iterator();
 153       return new Iterator<Reader>()
 154       {
 155         @Override
 156         public boolean hasNext()
 157         {
 158           return rvals.hasNext();
 159         }
 160
 161         @Override
 162         public Reader next()
 163         {
 164           JSONObject val = (JSONObject) rvals.next();
 165
 166           Object sval = null;
 167           try
 168           {
 169             sval = val.get("2D");
 170           } catch (Exception x)
 171           {
 172             x.printStackTrace();
 173           }
 174           ;
 175           if (sval == null)
 176           {
 177             System.err
 178                     .println("DEVELOPER WARNING: Annotate3d didn't return a '2D' tag in its response. Consider checking output of server. Response was :"
 179                             + val.toString());
 180
 181             sval = "";
 182           }
 183           return new StringReader(
 184                   (sval instanceof JSONObject) ? ((JSONObject) sval)
 185                           .toString() : sval.toString());
 186
 187         }
 188
 189         @Override
 190         public void remove()
 191         {
 192           throw new Error("Remove: Not implemented");
 193
 194         }
 195
 196         @Override
 197         protected Object clone() throws CloneNotSupportedException
 198         {
 199           throw new CloneNotSupportedException("Clone: Not implemented");
 200         }
 201
 202         @Override
 203         public boolean equals(Object obj)
 204         {
 205           return super.equals(obj);
 206         }
 207
 208         @Override
 209         protected void finalize() throws Throwable
 210         {
 211           while (rvals.hasNext())
 212           {
 213             rvals.next();
 214           }
 215           super.finalize();
 216         }
 217       };
 218     } catch (Exception foo)
 219     {
 220       throw new Exception(
 221               "Couldn't parse response from Annotate3d server.", foo);
 222     }
 223
 224   }
 225
 226   public static Iterator<Reader> getRNAMLForPDBId(String pdbid)
 227           throws Exception
 228   {
 229     List<NameValuePair> vals = new ArrayList<NameValuePair>();
 230     vals.add(new BasicNameValuePair("tool", "rnaview"));
 231     vals.add(new BasicNameValuePair("pdbid", pdbid));
 232     vals.add(new BasicNameValuePair("output", "rnaml"));
 233     java.net.URL geturl = new URL(twoDtoolsURL + "?tool=rnaview&pdbid="
 234             + pdbid + "&output=rnaml");
 235     // return processJsonResponseFor(new
 236     // InputStreamReader(geturl.openStream()));
 237     ArrayList<Reader> readers = new ArrayList<Reader>();
 238     readers.add(new InputStreamReader(geturl.openStream()));
 239     return readers.iterator();
 240   }
 241
 242 }