cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/NamePortalController.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   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.
   9 */
  10
  11 package eu.etaxonomy.cdm.remote.controller;
  12
  13 import java.io.IOException;
  14 import java.util.Arrays;
  15 import java.util.List;
  16 import java.util.UUID;
  17
  18 import javax.servlet.http.HttpServletRequest;
  19 import javax.servlet.http.HttpServletResponse;
  20
  21 import org.springframework.beans.factory.annotation.Autowired;
  22 import org.springframework.stereotype.Controller;
  23 import org.springframework.web.bind.annotation.PathVariable;
  24 import org.springframework.web.bind.annotation.RequestMapping;
  25 import org.springframework.web.bind.annotation.RequestMethod;
  26 import org.springframework.web.servlet.ModelAndView;
  27
  28 import eu.etaxonomy.cdm.api.service.IDescriptionService;
  29 import eu.etaxonomy.cdm.api.service.INameService;
  30 import eu.etaxonomy.cdm.api.service.pager.Pager;
  31 import eu.etaxonomy.cdm.database.UpdatableRoutingDataSource;
  32 import eu.etaxonomy.cdm.model.description.TaxonNameDescription;
  33 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  34 import eu.etaxonomy.cdm.model.name.TypeDesignationBase;
  35
  36 /**
  37  * The NamePortalController class is a Spring MVC Controller.
  38  * <p>
  39  * The syntax of the mapped service URIs contains the the {datasource-name} path element.
  40  * The available {datasource-name}s are defined in a configuration file which
  41  * is loaded by the {@link UpdatableRoutingDataSource}. If the
  42  * UpdatableRoutingDataSource is not being used in the actual application
  43  * context any arbitrary {datasource-name} may be used.
  44  * <p>
  45  * Methods mapped at type level, inherited from super classes ({@link BaseController}):
  46  * <blockquote>
  47  * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;name&#x002F;{name-uuid}</b>
  48  *
  49  * Get the {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
  50  * The returned TaxonNameBase is initialized by
  51  * the following strategy: -- NONE --
  52  * </blockquote>
  53  *
  54  * @author a.kohlbecker
  55  * @date 24.03.2009
  56  */
  57
  58 @Controller
  59 @RequestMapping(value = {"/portal/name/{uuid}"})
  60 public class NamePortalController extends BaseController<TaxonNameBase, INameService>
  61 {
  62
  63     private static final List<String> TYPEDESIGNATION_INIT_STRATEGY = Arrays.asList(new String []{
  64             "typeName.$",
  65             "typeSpecimen",
  66             "typeStatus.representations",
  67             "typifiedNames.nomenclaturalReference.authorTeam",
  68             "citation.authorTeam.$",
  69             "typeSpecimen.media"
  70     });
  71
  72
  73     private static final List<String> NAMEDESCRIPTION_INIT_STRATEGY = Arrays.asList(new String []{
  74             "uuid",
  75             "feature",
  76             "elements.$",
  77             "elements.multilanguageText",
  78             "elements.media",
  79     });
  80
  81
  82 //      public NamePortalController(){
  83 //              super();
  84 //              setInitializationStrategy(Arrays.asList(new String[]{"$"})); //TODO required???
  85 //      }
  86
  87     /* (non-Javadoc)
  88      * @see eu.etaxonomy.cdm.remote.controller.GenericController#setService(eu.etaxonomy.cdm.api.service.IService)
  89      */
  90     @Autowired
  91     @Override
  92     public void setService(INameService service) {
  93         this.service = service;
  94     }
  95
  96     @Autowired
  97     private IDescriptionService descriptionService;
  98
  99     /**
 100      * Get the list of {@link TypeDesignationBase}s of the
 101      * {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
 102      * <p>
 103      * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;name&#x002F;{name-uuid}&#x002F;typeDesignations</b>
 104      *
 105      * @param request
 106      * @param response
 107      * @return a List of {@link TypeDesignationBase} entities which are initialized
 108      *         using the following initialization strategy:
 109      *         {@link #TYPEDESIGNATION_INIT_STRATEGY}
 110      * @throws IOException
 111      */
 112     @SuppressWarnings("unchecked")
 113     @RequestMapping(
 114             value = {"typeDesignations"},
 115             method = RequestMethod.GET)
 116     public List<TypeDesignationBase> doGetTypeDesignations(@PathVariable("uuid") UUID uuid,
 117             HttpServletRequest request, HttpServletResponse response)throws IOException {
 118         ModelAndView mv = new ModelAndView();
 119         TaxonNameBase tnb = getCdmBaseInstance(uuid, response, (List<String>)null);
 120         Pager<TypeDesignationBase> p = service.getTypeDesignations(tnb,  null, null, null, TYPEDESIGNATION_INIT_STRATEGY);
 121         return p.getRecords();
 122     }
 123
 124     /**
 125      * Get the list of {@link TaxonNameDescription}s of the Name associated with the
 126      * {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
 127      * <p>
 128      * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;name&#x002F;{name-uuid}&#x002F;descriptions</b>
 129      *
 130      * @param request
 131      * @param response
 132      * @return a List of {@link TaxonNameDescription} entities which are initialized
 133      *         using the following initialization strategy:
 134      *         {@link #NAMEDESCRIPTION_INIT_STRATEGY}
 135      * @throws IOException
 136      */
 137     @RequestMapping(
 138             value = {"taxonNameDescriptions"},
 139             method = RequestMethod.GET)
 140     public List<TaxonNameDescription> doGetNameDescriptions(@PathVariable("uuid") UUID uuid,
 141             HttpServletRequest request, HttpServletResponse response)throws IOException {
 142         logger.info("doGetNameDescriptions()" + request.getRequestURI());
 143         TaxonNameBase tnb = service.load(uuid, null);
 144         Pager<TaxonNameDescription> p = descriptionService.getTaxonNameDescriptions(tnb, null, null, NAMEDESCRIPTION_INIT_STRATEGY);
 145         return p.getRecords();
 146     }
 147
 148
 149 }