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