3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
11 package eu
.etaxonomy
.cdm
.remote
.controller
;
13 import io
.swagger
.annotations
.Api
;
15 import java
.io
.IOException
;
16 import java
.util
.Arrays
;
17 import java
.util
.List
;
18 import java
.util
.UUID
;
20 import javax
.servlet
.http
.HttpServletRequest
;
21 import javax
.servlet
.http
.HttpServletResponse
;
23 import org
.springframework
.beans
.factory
.annotation
.Autowired
;
24 import org
.springframework
.stereotype
.Controller
;
25 import org
.springframework
.web
.bind
.annotation
.PathVariable
;
26 import org
.springframework
.web
.bind
.annotation
.RequestMapping
;
27 import org
.springframework
.web
.bind
.annotation
.RequestMethod
;
28 import org
.springframework
.web
.servlet
.ModelAndView
;
30 import eu
.etaxonomy
.cdm
.api
.service
.IDescriptionService
;
31 import eu
.etaxonomy
.cdm
.api
.service
.INameService
;
32 import eu
.etaxonomy
.cdm
.api
.service
.pager
.Pager
;
33 import eu
.etaxonomy
.cdm
.database
.UpdatableRoutingDataSource
;
34 import eu
.etaxonomy
.cdm
.model
.description
.TaxonNameDescription
;
35 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
36 import eu
.etaxonomy
.cdm
.model
.name
.TypeDesignationBase
;
39 * The NamePortalController class is a Spring MVC Controller.
41 * The syntax of the mapped service URIs contains the the {datasource-name} path element.
42 * The available {datasource-name}s are defined in a configuration file which
43 * is loaded by the {@link UpdatableRoutingDataSource}. If the
44 * UpdatableRoutingDataSource is not being used in the actual application
45 * context any arbitrary {datasource-name} may be used.
47 * Methods mapped at type level, inherited from super classes ({@link BaseController}):
49 * URI: <b>/{datasource-name}/portal/name/{name-uuid}</b>
51 * Get the {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
52 * The returned TaxonNameBase is initialized by
53 * the following strategy: -- NONE --
56 * @author a.kohlbecker
62 @RequestMapping(value
= {"/portal/name/{uuid}"})
63 public class NamePortalController
extends BaseController
<TaxonNameBase
, INameService
>
66 private static final List
<String
> TYPEDESIGNATION_INIT_STRATEGY
= Arrays
.asList(new String
[]{
69 "typeStatus.representations",
70 "typifiedNames.nomenclaturalReference.authorship",
71 "citation.authorship.$",
76 private static final List
<String
> NAMEDESCRIPTION_INIT_STRATEGY
= Arrays
.asList(new String
[]{
78 "elements.multilanguageText",
83 // public NamePortalController(){
85 // setInitializationStrategy(Arrays.asList(new String[]{"$"})); //TODO required???
89 * @see eu.etaxonomy.cdm.remote.controller.GenericController#setService(eu.etaxonomy.cdm.api.service.IService)
93 public void setService(INameService service
) {
94 this.service
= service
;
98 private IDescriptionService descriptionService
;
101 * Get the list of {@link TypeDesignationBase}s of the
102 * {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
104 * URI: <b>/{datasource-name}/portal/name/{name-uuid}/typeDesignations</b>
108 * @return a List of {@link TypeDesignationBase} entities which are initialized
109 * using the following initialization strategy:
110 * {@link #TYPEDESIGNATION_INIT_STRATEGY}
111 * @throws IOException
113 @SuppressWarnings("unchecked")
115 value
= {"typeDesignations"},
116 method
= RequestMethod
.GET
)
117 public List
<TypeDesignationBase
> doGetTypeDesignations(@PathVariable("uuid") UUID uuid
,
118 HttpServletRequest request
, HttpServletResponse response
)throws IOException
{
119 ModelAndView mv
= new ModelAndView();
120 TaxonNameBase tnb
= getCdmBaseInstance(uuid
, response
, (List
<String
>)null);
121 Pager
<TypeDesignationBase
> p
= service
.getTypeDesignations(tnb
, null, null, null, TYPEDESIGNATION_INIT_STRATEGY
);
122 return p
.getRecords();
126 * Get the list of {@link TaxonNameDescription}s of the Name associated with the
127 * {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
129 * URI: <b>/{datasource-name}/portal/name/{name-uuid}/descriptions</b>
133 * @return a List of {@link TaxonNameDescription} entities which are initialized
134 * using the following initialization strategy:
135 * {@link #NAMEDESCRIPTION_INIT_STRATEGY}
136 * @throws IOException
139 value
= {"taxonNameDescriptions"},
140 method
= RequestMethod
.GET
)
141 public List
<TaxonNameDescription
> doGetNameDescriptions(@PathVariable("uuid") UUID uuid
,
142 HttpServletRequest request
, HttpServletResponse response
)throws IOException
{
143 logger
.info("doGetNameDescriptions()" + request
.getRequestURI());
144 TaxonNameBase tnb
= service
.load(uuid
, null);
145 Pager
<TaxonNameDescription
> p
= descriptionService
.getTaxonNameDescriptions(tnb
, null, null, NAMEDESCRIPTION_INIT_STRATEGY
);
146 return p
.getRecords();