Salome HOME
Actions menu properties are refactored, unnecessary code is removed.
[tools/siman.git] / Workspace / Siman / src / org / splat / simer / NewStudyAction.java
1 package org.splat.simer;
2
3 import java.util.List;
4 import java.util.ResourceBundle;
5
6 import org.splat.dal.bo.som.Scenario;
7 import org.splat.dal.bo.som.SimulationContext;
8 import org.splat.dal.bo.som.SimulationContextType;
9 import org.splat.dal.bo.som.Study;
10 import org.splat.kernel.InvalidPropertyException;
11 import org.splat.kernel.MissedPropertyException;
12 import org.splat.kernel.MultiplyDefinedException;
13 import org.splat.service.ScenarioService;
14 import org.splat.service.SimulationContextService;
15 import org.splat.wapp.Constants;
16
17 /**
18  * Action for creation of a new study.
19  */
20 public class NewStudyAction extends Action {
21
22         /**
23          * Serial version ID.
24          */
25         private static final long serialVersionUID = 693943641800113782L;
26         /**
27          * Sequential number of the new study for appending to its default title.
28          */
29         private static int number = 0;
30
31         /**
32          * Title of the new study.
33          */
34         private String _title = null;
35         /**
36          * List of available project contexts for selection for the new study.
37          */
38         private transient List<SimulationContext> _contelm = null;
39         /**
40          * Project context.
41          */
42         private String _projectContext = null;
43
44         /**
45          * Injected simulation context service.
46          */
47         private SimulationContextService _simulationContextService;
48         /**
49          * Injected scenario service.
50          */
51         private ScenarioService _scenarioService;
52
53         // ==============================================================================================================================
54         // Action methods
55         // ==============================================================================================================================
56
57         /**
58          * Fill the values of the drop-down list, and initialize a menu.
59          * 
60          * @return SUCCESS
61          */
62         public String doInitialize() {
63
64                 // get the list of the simulation contexts of the study
65                 _contelm = getSimulationContextService().getSimulationContextList();
66
67                 // set the default name of the new study
68                 ResourceBundle locale = ResourceBundle.getBundle("labels",
69                                 getApplicationSettings().getCurrentLocale());
70                 _title = locale.getString("label.study") + " "
71                                 + String.valueOf(number + 1);
72
73                 initializationFullScreenContext(Constants.CREATE_MENU, Constants.NONE,
74                                 Constants.OPEN);
75
76                 return SUCCESS;
77         }
78
79         /**
80          * Create a new study.
81          * 
82          * @return SUCCESS if the new study is created, INPUT if project context is not defined, ERROR if failed
83          * @throws InvalidPropertyException
84          *             if some property has invalid value
85          * @throws MultiplyDefinedException
86          *             if some property is defined several times
87          * @throws MissedPropertyException
88          *             if properties of the new study are invalid
89          */
90         public String doCreate() throws InvalidPropertyException,
91                         MissedPropertyException, MultiplyDefinedException {
92                 String[] input = _projectContext.split(",");
93                 int valid = Integer.valueOf(input[0]);
94                 String value = ""; // input[1] if exists
95
96                 Study.Properties sprop = new Study.Properties();
97
98                 // Check arguments and creation of the study
99                 if (valid == -1) {
100                         SimulationContext.Properties cprop = new SimulationContext.Properties();
101                         SimulationContextType product = getSimulationContextService()
102                                         .selectType("product");
103                         _contelm = getSimulationContextService()
104                                         .selectSimulationContextsWhere(cprop.setType(product));
105                         return INPUT; // Title empty, simply wait for input without error message
106                 }
107                 if (valid == 0) {
108                         value = input[1].trim();
109                         if (value.length() == 0) {
110                                 initializationScreenContext(Constants.CREATE_MENU);
111                                 return INPUT; // No need to reinitialize the list of existing products
112                         }
113                 }
114                 sprop.setTitle(_title).setManager(getConnectedUser());
115                 sprop.checkValidity();
116                 sprop.disableCheck();
117                 try {
118                         // Addition of a default scenario
119                         ResourceBundle locale = ResourceBundle.getBundle("labels",
120                                         getApplicationSettings().getCurrentLocale());
121                         Scenario.Properties oprop = new Scenario.Properties();
122                         oprop.setTitle(locale.getString("label.scenario") + " 1");
123
124                         // Addition of the entered project context
125                         SimulationContext.Properties cprop = new SimulationContext.Properties();
126                         if (valid == 0) { // Input of new project context
127                                 cprop.setType(
128                                                 getSimulationContextService().selectType("product"))
129                                                 .setValue(value);
130                         } else { // Selection of existing project context
131                                 cprop.setIndex(valid);
132                         }
133                         Study study = getScenarioService().createStudy(sprop, oprop, cprop);
134                         // Update of the session
135                         number += 1;
136                         open(study); // Opens the study,
137
138                         initializationFullScreenContext(Constants.STUDY_MENU,
139                                         Constants.NONE, Constants.OPEN);
140
141                         return SUCCESS;
142                 } catch (Exception error) {
143                         LOG.error("Unable to save the study, reason:", error);
144                         setErrorCode("message.error.newstudy");
145                         initializationScreenContext(Constants.NONE);
146                         return ERROR;
147                 }
148         }
149
150         // ==============================================================================================================================
151         // Getters and setters
152         // ==============================================================================================================================
153
154         /**
155          * Get the selected project context for the new study.
156          * 
157          * @return the selected project context
158          */
159         public String getProjectContext() {
160                 return _projectContext;
161         }
162
163         /**
164          * Get the list of available project contexts.
165          * 
166          * @return the list of context values
167          */
168         public List<SimulationContext> getProjectContextValues() {
169                 return _contelm;
170         }
171
172         /**
173          * Get the title of the new study.
174          * 
175          * @return the title
176          */
177         public String getTitle() {
178                 return _title;
179         }
180
181         /**
182          * Set the project context for the new study.
183          * 
184          * @param value
185          *            the project context value.
186          */
187         public void setProjectContext(final String value) {
188                 this._projectContext = value;
189         }
190
191         /**
192          * Set the title of the new study.
193          * 
194          * @param value
195          *            the title to set
196          */
197         public void setTitle(final String value) {
198                 this._title = value;
199         }
200
201         /**
202          * Get the simulationContextService.
203          * 
204          * @return the simulationContextService
205          */
206         public SimulationContextService getSimulationContextService() {
207                 return _simulationContextService;
208         }
209
210         /**
211          * Set the simulationContextService.
212          * 
213          * @param simulationContextService
214          *            the simulationContextService to set
215          */
216         public void setSimulationContextService(
217                         final SimulationContextService simulationContextService) {
218                 _simulationContextService = simulationContextService;
219         }
220
221         /**
222          * Get the scenarioService.
223          * 
224          * @return the scenarioService
225          */
226         public ScenarioService getScenarioService() {
227                 return _scenarioService;
228         }
229
230         /**
231          * Set the scenarioService.
232          * 
233          * @param scenarioService
234          *            the scenarioService to set
235          */
236         public void setScenarioService(final ScenarioService scenarioService) {
237                 _scenarioService = scenarioService;
238         }
239 }