1
|
/**
|
2
|
* Copyright (C) 2009 EDIT European Distributed Institute of Taxonomy
|
3
|
* http://www.e-taxonomy.eu
|
4
|
*
|
5
|
* The contents of this file are subject to the Mozilla Public License Version
|
6
|
* 1.1 See LICENSE.TXT at the top of this package for the full license terms.
|
7
|
*/
|
8
|
|
9
|
package eu.etaxonomy.cdm.remote.controller;
|
10
|
|
11
|
import java.io.IOException;
|
12
|
import java.util.Arrays;
|
13
|
import java.util.List;
|
14
|
import java.util.UUID;
|
15
|
|
16
|
import javax.servlet.http.HttpServletRequest;
|
17
|
import javax.servlet.http.HttpServletResponse;
|
18
|
|
19
|
import org.apache.log4j.Logger;
|
20
|
import org.springframework.beans.factory.annotation.Autowired;
|
21
|
import org.springframework.stereotype.Controller;
|
22
|
import org.springframework.web.bind.WebDataBinder;
|
23
|
import org.springframework.web.bind.annotation.InitBinder;
|
24
|
import org.springframework.web.bind.annotation.RequestMapping;
|
25
|
import org.springframework.web.bind.annotation.RequestMethod;
|
26
|
import org.springframework.web.bind.annotation.RequestParam;
|
27
|
|
28
|
import eu.etaxonomy.cdm.api.service.IDescriptionService;
|
29
|
import eu.etaxonomy.cdm.api.service.ITaxonService;
|
30
|
import eu.etaxonomy.cdm.api.service.ITermService;
|
31
|
import eu.etaxonomy.cdm.api.service.pager.Pager;
|
32
|
import eu.etaxonomy.cdm.model.description.DescriptionBase;
|
33
|
import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
|
34
|
import eu.etaxonomy.cdm.model.description.Feature;
|
35
|
import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
|
36
|
import eu.etaxonomy.cdm.model.name.Rank;
|
37
|
import eu.etaxonomy.cdm.model.taxon.Taxon;
|
38
|
import eu.etaxonomy.cdm.persistence.query.MatchMode;
|
39
|
import eu.etaxonomy.cdm.remote.controller.util.PagerParameters;
|
40
|
import eu.etaxonomy.cdm.remote.editor.CdmTypePropertyEditor;
|
41
|
import eu.etaxonomy.cdm.remote.editor.DefinedTermBaseList;
|
42
|
import eu.etaxonomy.cdm.remote.editor.TermBaseListPropertyEditor;
|
43
|
import eu.etaxonomy.cdm.remote.editor.TermBasePropertyEditor;
|
44
|
import eu.etaxonomy.cdm.remote.editor.UUIDListPropertyEditor;
|
45
|
import eu.etaxonomy.cdm.remote.editor.UUIDPropertyEditor;
|
46
|
import eu.etaxonomy.cdm.remote.editor.UuidList;
|
47
|
import io.swagger.annotations.Api;
|
48
|
|
49
|
/**
|
50
|
* TODO write controller documentation
|
51
|
*
|
52
|
* @author a.kohlbecker
|
53
|
* @since 24.03.2009
|
54
|
*/
|
55
|
@Controller
|
56
|
@Api("descriptionElement")
|
57
|
@RequestMapping(value = {"/descriptionElement"})
|
58
|
public class DescriptionElementListController {
|
59
|
|
60
|
public static final Logger logger = Logger.getLogger(DescriptionElementListController.class);
|
61
|
|
62
|
|
63
|
@Autowired
|
64
|
private ITermService termService;
|
65
|
|
66
|
@Autowired
|
67
|
private ITaxonService taxonService;
|
68
|
|
69
|
@Autowired
|
70
|
public ProgressMonitorController progressMonitorController;
|
71
|
|
72
|
protected IDescriptionService service;
|
73
|
|
74
|
protected static final List<String> DESCRIPTION_ELEMENT_INIT_STRATEGY = Arrays.asList(new String []{
|
75
|
"$",
|
76
|
"multilanguageText"
|
77
|
});
|
78
|
|
79
|
/**
|
80
|
* @return
|
81
|
*/
|
82
|
protected List<String> getInitializationStrategy() {
|
83
|
return DESCRIPTION_ELEMENT_INIT_STRATEGY;
|
84
|
}
|
85
|
|
86
|
private String requestPathAndQuery(HttpServletRequest request) {
|
87
|
return AbstractController.requestPathAndQuery(request);
|
88
|
}
|
89
|
|
90
|
@Autowired
|
91
|
public void setService(IDescriptionService service) {
|
92
|
this.service = service;
|
93
|
}
|
94
|
|
95
|
@InitBinder
|
96
|
public void initBinder(WebDataBinder binder) {
|
97
|
binder.registerCustomEditor(UUID.class, new UUIDPropertyEditor());
|
98
|
binder.registerCustomEditor(UuidList.class, new UUIDListPropertyEditor());
|
99
|
binder.registerCustomEditor(DefinedTermBaseList.class, new TermBaseListPropertyEditor<Feature>(termService));
|
100
|
binder.registerCustomEditor(NamedAreaLevel.class, new TermBasePropertyEditor<NamedAreaLevel>(termService));
|
101
|
binder.registerCustomEditor(Rank.class, new TermBasePropertyEditor<Rank>(termService));
|
102
|
binder.registerCustomEditor(Class.class, new CdmTypePropertyEditor());
|
103
|
}
|
104
|
|
105
|
|
106
|
/**
|
107
|
* Requires the query parameter "descriptionType" to be present
|
108
|
*
|
109
|
* @param features
|
110
|
* @param descriptionType
|
111
|
* @param type
|
112
|
* @param pageSize
|
113
|
* @param pageIndex
|
114
|
* @param request
|
115
|
* @param response
|
116
|
* @return
|
117
|
* @throws IOException
|
118
|
*/
|
119
|
@RequestMapping(value = "byFeature", method = RequestMethod.GET) // mapped as absolute path, see CdmAntPathMatcher
|
120
|
public Pager<? extends DescriptionElementBase> doPageDescriptionElementsByFeature(
|
121
|
@RequestParam(value = "features", required = false) DefinedTermBaseList<Feature> features,
|
122
|
@RequestParam(value = "descriptionType", required = true) Class<? extends DescriptionBase> descriptionType,
|
123
|
@RequestParam(value = "type", required = false) Class<? extends DescriptionElementBase> type,
|
124
|
@RequestParam(value = "pageSize", required = false) Integer pageSize,
|
125
|
@RequestParam(value = "pageIndex", required = false) Integer pageIndex, HttpServletRequest request,
|
126
|
HttpServletResponse response) throws IOException {
|
127
|
|
128
|
logger.info("doPageDescriptionElementsByFeature : " + requestPathAndQuery(request));
|
129
|
|
130
|
PagerParameters pagerParams = new PagerParameters(pageSize, pageIndex);
|
131
|
pagerParams.normalizeAndValidate(response);
|
132
|
|
133
|
if(features == null){
|
134
|
features = new DefinedTermBaseList<Feature>();
|
135
|
}
|
136
|
|
137
|
Pager<? extends DescriptionElementBase> pager = service.pageDescriptionElements(null, descriptionType, features.asSet(),
|
138
|
type, pagerParams.getPageSize(), pagerParams.getPageIndex(), getInitializationStrategy());
|
139
|
|
140
|
return pager;
|
141
|
}
|
142
|
|
143
|
/**
|
144
|
* Requires the query parameter "taxon" to be present
|
145
|
*
|
146
|
* @param taxon_uuid
|
147
|
* @param features
|
148
|
* @param type
|
149
|
* @param pageSize
|
150
|
* @param pageIndex
|
151
|
* @param request
|
152
|
* @param response
|
153
|
* @return
|
154
|
* @throws IOException
|
155
|
*/
|
156
|
@RequestMapping(value = "byTaxon", method = {RequestMethod.GET, RequestMethod.POST}) // mapped as absolute path, see CdmAntPathMatcher
|
157
|
public <T extends DescriptionElementBase> Pager<T> doGetDescriptionElementsForTaxon(
|
158
|
@RequestParam(value = "taxon", required = true) UUID taxon_uuid,
|
159
|
@RequestParam(value = "features", required = false) DefinedTermBaseList<Feature> features,
|
160
|
@RequestParam(value = "type", required = false) Class<T> type,
|
161
|
@RequestParam(value = "pageSize", required = false) Integer pageSize,
|
162
|
@RequestParam(value = "pageIndex", required = false) Integer pageIndex, HttpServletRequest request,
|
163
|
HttpServletResponse response) throws IOException {
|
164
|
|
165
|
logger.info("getDescriptionElementsForTaxon : " + requestPathAndQuery(request));
|
166
|
|
167
|
PagerParameters pagerParams = new PagerParameters(pageSize, pageIndex);
|
168
|
pagerParams.normalizeAndValidate(response);
|
169
|
|
170
|
Taxon taxon = null;
|
171
|
if( taxon_uuid!= null){
|
172
|
try {
|
173
|
taxon = (Taxon) taxonService.load(taxon_uuid);
|
174
|
} catch (Exception e) {
|
175
|
HttpStatusMessage.UUID_NOT_FOUND.send(response);
|
176
|
}
|
177
|
}
|
178
|
|
179
|
Pager<T> pager = service.pageDescriptionElementsForTaxon(taxon, features != null ? features.asSet() : null, type, pageSize,
|
180
|
pageIndex, getInitializationStrategy());
|
181
|
return pager;
|
182
|
}
|
183
|
|
184
|
/**
|
185
|
*
|
186
|
* @param queryString
|
187
|
* @param type
|
188
|
* @param pageSize
|
189
|
* @param pageIndex
|
190
|
* @param matchMode
|
191
|
* @param request
|
192
|
* @param response
|
193
|
* @return
|
194
|
* @throws IOException
|
195
|
*/
|
196
|
@RequestMapping(value = "find", method = RequestMethod.GET) // mapped as absolute path, see CdmAntPathMatcher
|
197
|
public Pager<? extends DescriptionElementBase> doFindDescriptionElements(
|
198
|
@RequestParam(value = "query", required = true) String queryString,
|
199
|
@RequestParam(value = "type", required = false) Class<? extends DescriptionElementBase> type,
|
200
|
@RequestParam(value = "pageSize", required = false) Integer pageSize,
|
201
|
@RequestParam(value = "pageIndex", required = false) Integer pageIndex,
|
202
|
@RequestParam(value = "matchMode", required = false) MatchMode matchMode,
|
203
|
HttpServletRequest request,
|
204
|
HttpServletResponse response
|
205
|
)
|
206
|
throws IOException {
|
207
|
|
208
|
logger.info("doFindDescriptionElements : " + request.getRequestURI() + "?" + request.getQueryString() );
|
209
|
|
210
|
PagerParameters pagerParams = new PagerParameters(pageSize, pageIndex);
|
211
|
pagerParams.normalizeAndValidate(response);
|
212
|
|
213
|
Pager<? extends DescriptionElementBase> pager = service.searchElements(type, queryString, pageSize, pageIndex, null, getInitializationStrategy());
|
214
|
|
215
|
return pager;
|
216
|
}
|
217
|
|
218
|
}
|