src/jalview/ws/jws2/jabaws2/Jws2InstanceFactory.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.ws.jws2.jabaws2;
  22
  23 import jalview.bin.Instance;
  24 import jalview.ws.jws2.AAConClient;
  25 import jalview.ws.jws2.RNAalifoldClient;
  26 import jalview.ws.uimodel.AlignAnalysisUIText;
  27
  28 import java.util.HashMap;
  29 import java.util.HashSet;
  30
  31 import compbio.data.msa.JABAService;
  32
  33 public class Jws2InstanceFactory
  34 {
  35
  36   private Jws2InstanceFactory()
  37   {
  38     // private singleton
  39   }
  40
  41   private static Jws2InstanceFactory getInstance()
  42   {
  43     Instance j = Instance.getInstance();
  44     return (j.jws2InstanceFactory == null
  45             ? j.jws2InstanceFactory = new Jws2InstanceFactory()
  46             : j.jws2InstanceFactory);
  47   }
  48
  49   private HashMap<String, AlignAnalysisUIText> aaConGUI;
  50
  51   private HashSet<String> ignoreGUI;
  52
  53   private static String category_rewrite(String cat_name)
  54   {
  55     return (cat_name != null && cat_name.equals("Prediction"))
  56             ? "Secondary Structure Prediction"
  57             : cat_name;
  58   }
  59
  60   private void init()
  61   {
  62     if (aaConGUI == null)
  63     {
  64       aaConGUI = new HashMap<>();
  65       aaConGUI.put(compbio.ws.client.Services.AAConWS.toString(),
  66               AAConClient.getAlignAnalysisUITest());
  67       aaConGUI.put(compbio.ws.client.Services.RNAalifoldWS.toString(),
  68               RNAalifoldClient.getAlignAnalysisUITest());
  69       // ignore list for JABAWS services not supported in jalview ...
  70       ignoreGUI = new HashSet<>();
  71     }
  72   }
  73
  74   /**
  75    * exclusion list to avoid creating GUI elements for services we don't fully
  76    * support
  77    *
  78    * @param serviceType
  79    * @return
  80    */
  81   public static boolean ignoreService(String serviceType)
  82   {
  83     getInstance().init();
  84     return (getInstance().ignoreGUI.contains(serviceType.toString()));
  85   }
  86
  87   /**
  88    * construct a service instance and configure it with any additional
  89    * properties needed so Jalview can access it correctly
  90    *
  91    * @param jwsservers
  92    * @param serviceType
  93    * @param name
  94    * @param description
  95    * @param service
  96    * @return
  97    */
  98   public static Jws2Instance newJws2Instance(String jwsservers,
  99           String serviceType, String name, String description,
 100           JABAService service)
 101   {
 102     getInstance().init();
 103     Jws2Instance svc = new Jws2Instance(jwsservers, serviceType,
 104             category_rewrite(name), description, service);
 105     svc.aaui = getInstance().aaConGUI.get(serviceType.toString());
 106     return svc;
 107   }
 108
 109 }