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