1
|
/**
|
2
|
* Copyright (C) 2017 EDIT
|
3
|
* European Distributed Institute of Taxonomy
|
4
|
* http://www.e-taxonomy.eu
|
5
|
*
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
8
|
*/
|
9
|
package eu.etaxonomy.cdm.vaadin.view.registration;
|
10
|
|
11
|
import java.util.ArrayList;
|
12
|
import java.util.Arrays;
|
13
|
import java.util.Collection;
|
14
|
import java.util.EnumSet;
|
15
|
import java.util.HashSet;
|
16
|
import java.util.List;
|
17
|
import java.util.Set;
|
18
|
import java.util.UUID;
|
19
|
|
20
|
import org.apache.commons.lang3.StringUtils;
|
21
|
import org.springframework.beans.factory.annotation.Autowired;
|
22
|
import org.springframework.security.core.Authentication;
|
23
|
import org.vaadin.spring.events.EventScope;
|
24
|
import org.vaadin.spring.events.annotation.EventBusListenerMethod;
|
25
|
|
26
|
import com.vaadin.data.util.BeanItemContainer;
|
27
|
import com.vaadin.navigator.Navigator;
|
28
|
import com.vaadin.spring.annotation.SpringComponent;
|
29
|
import com.vaadin.spring.annotation.ViewScope;
|
30
|
import com.vaadin.ui.AbstractSelect;
|
31
|
import com.vaadin.ui.TextField;
|
32
|
import com.vaadin.ui.UI;
|
33
|
|
34
|
import eu.etaxonomy.cdm.api.service.dto.RegistrationDTO;
|
35
|
import eu.etaxonomy.cdm.api.service.dto.TypeDesignationStatusFilter;
|
36
|
import eu.etaxonomy.cdm.api.service.pager.Pager;
|
37
|
import eu.etaxonomy.cdm.api.service.registration.IRegistrationWorkingSetService;
|
38
|
import eu.etaxonomy.cdm.model.common.Language;
|
39
|
import eu.etaxonomy.cdm.model.name.RegistrationStatus;
|
40
|
import eu.etaxonomy.cdm.model.permission.User;
|
41
|
import eu.etaxonomy.cdm.model.reference.Reference;
|
42
|
import eu.etaxonomy.cdm.service.CdmBeanItemContainerFactory;
|
43
|
import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationItem;
|
44
|
import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent;
|
45
|
import eu.etaxonomy.cdm.vaadin.event.PagingEvent;
|
46
|
import eu.etaxonomy.cdm.vaadin.event.ShowDetailsEvent;
|
47
|
import eu.etaxonomy.cdm.vaadin.event.UpdateResultsEvent;
|
48
|
import eu.etaxonomy.vaadin.mvp.AbstractPresenter;
|
49
|
import eu.etaxonomy.vaadin.ui.navigation.NavigationEvent;
|
50
|
|
51
|
/**
|
52
|
*
|
53
|
* @author a.kohlbecker
|
54
|
* @since Mar 3, 2017
|
55
|
*
|
56
|
*/
|
57
|
@SpringComponent
|
58
|
@ViewScope
|
59
|
public class ListPresenter extends AbstractPresenter<ListView> {
|
60
|
|
61
|
private static final String REGISTRATION_LIST_PRESENTER_SEARCH_FILTER = "registration.listPresenter.searchFilter";
|
62
|
|
63
|
private static final EnumSet<RegistrationStatus> inProgressStatus = EnumSet.of(
|
64
|
RegistrationStatus.PREPARATION,
|
65
|
RegistrationStatus.CURATION,
|
66
|
RegistrationStatus.READY
|
67
|
);
|
68
|
|
69
|
private static final long serialVersionUID = 5419947244621450665L;
|
70
|
|
71
|
// protected TypeDesignationStatusBase<?> NULL_TYPE_STATUS = NameTypeDesignationStatus.NewInstance("- none -", "- none -", "- none -");
|
72
|
|
73
|
@Autowired
|
74
|
private IRegistrationWorkingSetService workingSetService;
|
75
|
|
76
|
@Autowired
|
77
|
protected CdmBeanItemContainerFactory cdmBeanItemContainerFactory;
|
78
|
|
79
|
private Integer pageIndex = 0;
|
80
|
private Integer pageSize = null;
|
81
|
|
82
|
/**
|
83
|
* @return the workingSetService
|
84
|
*/
|
85
|
public IRegistrationWorkingSetService getWorkingSetService() {
|
86
|
return workingSetService;
|
87
|
}
|
88
|
|
89
|
|
90
|
@Override
|
91
|
public void handleViewEntered() {
|
92
|
|
93
|
List<String> viewParameters = getNavigationManager().getCurrentViewParameters();
|
94
|
if(viewParameters.get(0).equals(ListView.Mode.inProgress.name())){
|
95
|
getView().setViewMode(ListViewBean.Mode.inProgress);
|
96
|
getView().getRegistrationStatusFilter().setVisible(false);
|
97
|
} else {
|
98
|
getView().setViewMode(ListViewBean.Mode.all);
|
99
|
}
|
100
|
if(viewParameters.size() > 1){
|
101
|
// expecting the second param to be the page index
|
102
|
try {
|
103
|
pageIndex = Integer.parseInt(viewParameters.get(1));
|
104
|
} catch (NumberFormatException e) {
|
105
|
// only log and display the page 0
|
106
|
logger.error("Invalid page index parameter " + viewParameters.get(1) + " in " + ((Navigator)getNavigationManager()).getState());
|
107
|
}
|
108
|
}
|
109
|
|
110
|
if(getView().getSubmitterFilter() != null){
|
111
|
getView().getSubmitterFilter().setContainerDataSource(cdmBeanItemContainerFactory.buildBeanItemContainer(User.class));
|
112
|
getView().getSubmitterFilter().setItemCaptionPropertyId("username");
|
113
|
}
|
114
|
|
115
|
BeanItemContainer<TypeDesignationStatusFilter> buildTermItemContainer = new BeanItemContainer<>(TypeDesignationStatusFilter.class);
|
116
|
// TODO use UI.getCurrent().getPage().getWebBrowser().getLocale() or the LocaleContext component to get the preferredLanguage?
|
117
|
Collection<TypeDesignationStatusFilter> statusFilterTerms = new ArrayList<>(getRepo().getNameService().getTypeDesignationStatusFilterTerms(Arrays.asList(Language.DEFAULT())));
|
118
|
statusFilterTerms.add(TypeDesignationStatusFilter.NULL_ELEMENT);
|
119
|
buildTermItemContainer.addAll(statusFilterTerms);
|
120
|
getView().getStatusTypeFilter().setContainerDataSource(buildTermItemContainer);
|
121
|
for(TypeDesignationStatusFilter dt : buildTermItemContainer.getItemIds()){
|
122
|
getView().getStatusTypeFilter().setItemCaption(dt, dt.toString());
|
123
|
}
|
124
|
buildTermItemContainer.sort(new String[]{"label"}, new boolean[]{true});
|
125
|
|
126
|
loadSearchFilterFromSession();
|
127
|
|
128
|
getView().populate(pageRegistrations(null, null));
|
129
|
}
|
130
|
|
131
|
/**
|
132
|
* {@inheritDoc}
|
133
|
*/
|
134
|
@Override
|
135
|
public void onViewExit() {
|
136
|
preserveSearchFilterInSession();
|
137
|
super.onViewExit();
|
138
|
}
|
139
|
|
140
|
/**
|
141
|
* FIXME write test !!!!!!!!!!!!!!!!!
|
142
|
*
|
143
|
* @return
|
144
|
*/
|
145
|
private Pager<RegistrationDTO> pageRegistrations(TextField textFieldOverride, String alternativeText) {
|
146
|
|
147
|
// prepare the filters
|
148
|
RegistrationSearchFilter filter = loadFilterFromView();
|
149
|
if(textFieldOverride != null && textFieldOverride == getView().getIdentifierFilter()){
|
150
|
filter.setIdentifierPattern(alternativeText);
|
151
|
}
|
152
|
|
153
|
if(textFieldOverride != null && textFieldOverride == getView().getTaxonNameFilter()){
|
154
|
filter.setNamePattern(alternativeText);
|
155
|
}
|
156
|
if(textFieldOverride != null && textFieldOverride == getView().getReferenceFilter()){
|
157
|
filter.setReferencePattern(alternativeText);
|
158
|
}
|
159
|
|
160
|
|
161
|
if(filter.getTypeStatus().contains(TypeDesignationStatusFilter.NULL_ELEMENT)){
|
162
|
Set<TypeDesignationStatusFilter> tmpSet = new HashSet<>();
|
163
|
tmpSet.addAll(filter.getTypeStatus());
|
164
|
tmpSet.remove(TypeDesignationStatusFilter.NULL_ELEMENT);
|
165
|
tmpSet.add(null);
|
166
|
filter.setTypeStatus(tmpSet);
|
167
|
}
|
168
|
|
169
|
|
170
|
if(getView().getViewMode().equals(ListView.Mode.inProgress)){
|
171
|
filter.setRegistrationStatus(inProgressStatus);
|
172
|
}
|
173
|
|
174
|
List<UUID> typeDesignationStatus = new ArrayList<>(TypeDesignationStatusFilter.toTypeDesignationStatusUuids(filter.getTypeStatus()));
|
175
|
|
176
|
Pager<RegistrationDTO> dtoPager = getWorkingSetService().pageDTOs(
|
177
|
filter.getSubmitter() != null ? filter.getSubmitter().getUuid() : null,
|
178
|
filter.getRegistrationStatus() != null ? new ArrayList<>(filter.getRegistrationStatus()): null,
|
179
|
StringUtils.trimToNull(filter.getIdentifierPattern()),
|
180
|
StringUtils.trimToNull(filter.getNamePattern()),
|
181
|
StringUtils.trimToNull(filter.getReferencePattern()),
|
182
|
typeDesignationStatus,
|
183
|
pageSize,
|
184
|
pageIndex,
|
185
|
null);
|
186
|
return dtoPager;
|
187
|
}
|
188
|
|
189
|
@EventBusListenerMethod
|
190
|
public void onShowDetailsEvent(ShowDetailsEvent<RegistrationDTO, UUID> event) {
|
191
|
|
192
|
// FIXME check from own view!!!
|
193
|
if(getView() == null){
|
194
|
return;
|
195
|
}
|
196
|
|
197
|
UUID registrationUuid = event.getIdentifier();
|
198
|
|
199
|
RegistrationDTO regDto = getWorkingSetService().loadDtoByUuid(registrationUuid);
|
200
|
if(event.getProperty().equals(RegistrationItem.VALIDATION_PROBLEMS)){
|
201
|
|
202
|
getView().openDetailsPopup("Validation Problems", regDto.getValidationProblems());
|
203
|
|
204
|
} else if(event.getProperty().equals("blockedBy")){
|
205
|
|
206
|
Set<RegistrationDTO> blockingRegs = getWorkingSetService().loadBlockingRegistrations(registrationUuid);
|
207
|
RegistrationItem regItem = getView().getRegistrationItem(registrationUuid);
|
208
|
regItem.showBlockingRegistrations(blockingRegs);
|
209
|
}
|
210
|
|
211
|
}
|
212
|
|
213
|
@EventBusListenerMethod
|
214
|
public void onEntityChangeEvent(EntityChangeEvent event){
|
215
|
if(event.getEntityType().isAssignableFrom(Reference.class)){
|
216
|
// TODO update component showing the according reference, is there a Vaadin event supporting this?
|
217
|
}
|
218
|
}
|
219
|
|
220
|
@EventBusListenerMethod
|
221
|
public void onUpdateResultsEvent(UpdateResultsEvent event){
|
222
|
getView().populate(pageRegistrations(event.getField(), event.getNewText()));
|
223
|
}
|
224
|
|
225
|
@EventBusListenerMethod
|
226
|
public void onPagingEvent(PagingEvent event){
|
227
|
|
228
|
if(!event.getSourceView().equals(getView())){
|
229
|
return;
|
230
|
}
|
231
|
String viewName = getNavigationManager().getCurrentViewName();
|
232
|
List<String> viewNameParams = new ArrayList(getNavigationManager().getCurrentViewParameters());
|
233
|
if(viewNameParams.size() > 1){
|
234
|
viewNameParams.set(1, event.getPageIndex().toString());
|
235
|
} else {
|
236
|
viewNameParams.add(event.getPageIndex().toString());
|
237
|
}
|
238
|
viewEventBus.publish(EventScope.UI, this, new NavigationEvent(viewName, viewNameParams.toArray(new String[viewNameParams.size()])));
|
239
|
}
|
240
|
|
241
|
|
242
|
/**
|
243
|
*
|
244
|
*/
|
245
|
private void preserveSearchFilterInSession() {
|
246
|
|
247
|
RegistrationSearchFilter filter = loadFilterFromView();
|
248
|
UI.getCurrent().getSession().setAttribute(REGISTRATION_LIST_PRESENTER_SEARCH_FILTER, filter);
|
249
|
}
|
250
|
|
251
|
|
252
|
/**
|
253
|
*
|
254
|
*/
|
255
|
@SuppressWarnings("unchecked")
|
256
|
public RegistrationSearchFilter loadFilterFromView() {
|
257
|
|
258
|
|
259
|
RegistrationSearchFilter filter = new RegistrationSearchFilter();
|
260
|
filter.setIdentifierPattern(getView().getIdentifierFilter().getValue());
|
261
|
filter.setNamePattern(getView().getTaxonNameFilter().getValue());
|
262
|
if(getView().getSubmitterFilter() != null){
|
263
|
Object o = getView().getSubmitterFilter().getValue();
|
264
|
if(o != null){
|
265
|
filter.setSubmitter((User)o);
|
266
|
}
|
267
|
} else {
|
268
|
Authentication authentication = currentSecurityContext().getAuthentication();
|
269
|
if(authentication != null && authentication.getPrincipal() != null && authentication.getPrincipal() instanceof User){
|
270
|
filter.setSubmitter((User) authentication.getPrincipal());
|
271
|
}
|
272
|
}
|
273
|
if(getView().getStatusTypeFilter().getValue() != null) {
|
274
|
filter.setTypeStatus((Set<TypeDesignationStatusFilter>) getView().getStatusTypeFilter().getValue());
|
275
|
}
|
276
|
Object o = getView().getRegistrationStatusFilter().getValue();
|
277
|
if(o != null){
|
278
|
filter.setRegistrationStatus(EnumSet.of((RegistrationStatus)o));
|
279
|
}
|
280
|
return filter;
|
281
|
}
|
282
|
|
283
|
|
284
|
private void loadSearchFilterFromSession() {
|
285
|
Object o = UI.getCurrent().getSession().getAttribute(REGISTRATION_LIST_PRESENTER_SEARCH_FILTER);
|
286
|
if(o != null){
|
287
|
RegistrationSearchFilter filter = (RegistrationSearchFilter)o;
|
288
|
getView().getIdentifierFilter().setValue(filter.getIdentifierPattern());
|
289
|
getView().getTaxonNameFilter().setValue(filter.getNamePattern());
|
290
|
if(getView().getSubmitterFilter() != null){
|
291
|
getView().getSubmitterFilter().setValue(filter.getSubmitter());
|
292
|
}
|
293
|
setSelectValue(getView().getStatusTypeFilter(), filter.getTypeStatus());
|
294
|
setSelectValue(getView().getRegistrationStatusFilter(), filter.getRegistrationStatus());
|
295
|
}
|
296
|
|
297
|
}
|
298
|
|
299
|
/**
|
300
|
* @param statusTypeFilter
|
301
|
* @param typeStatus
|
302
|
*/
|
303
|
private void setSelectValue(AbstractSelect select, Set<?> itemsToChoose) {
|
304
|
|
305
|
if(itemsToChoose != null){
|
306
|
for(Object item : select.getContainerDataSource().getItemIds()){
|
307
|
if(item != null){
|
308
|
if(itemsToChoose.contains(item)){
|
309
|
select.select(item);
|
310
|
}
|
311
|
}
|
312
|
}
|
313
|
}
|
314
|
|
315
|
}
|
316
|
|
317
|
}
|