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