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