JAL-1620 version bump and release notes
[jalview.git] / src / jalview / ws / jws2 / jabaws2 / Jws2InstanceFactory.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
3  * Copyright (C) 2014 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.JPred301Client;
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   private static HashMap<String, AlignAnalysisUIText> aaConGUI;
36
37   private static HashSet<String> ignoreGUI;
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       // disable the JPred301 client in jalview ...
54       ignoreGUI = new HashSet<String>();
55       ignoreGUI.add(compbio.ws.client.Services.JpredWS.toString());
56       aaConGUI.put(compbio.ws.client.Services.JpredWS.toString(),
57               JPred301Client.getAlignAnalysisUITest());
58     }
59   }
60
61   /**
62    * exclusion list to avoid creating GUI elements for services we don't fully
63    * support
64    * 
65    * @param serviceType
66    * @return
67    */
68   public static boolean ignoreService(String serviceType)
69   {
70     init();
71     return (ignoreGUI.contains(serviceType.toString()));
72   }
73   /**
74    * construct a service instance and configure it with any additional
75    * properties needed so Jalview can access it correctly
76    * 
77    * @param jwsservers
78    * @param serviceType
79    * @param name
80    * @param description
81    * @param service
82    * @return
83    */
84   public static Jws2Instance newJws2Instance(String jwsservers,
85           String serviceType, String name, String description,
86           JABAService service)
87   {
88     init();
89     Jws2Instance svc = new Jws2Instance(jwsservers, serviceType,
90             category_rewrite(name), description, service);
91     svc.aaui = aaConGUI.get(serviceType.toString());
92     return svc;
93   }
94
95 }