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.model.description.TaxonNameDescription;
  32 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  33 import eu.etaxonomy.cdm.model.name.TypeDesignationBase;
  34
  35 /**
  36  * The NamePortalController class is a Spring MVC Controller.
  37  * <p>
  38  * The syntax of the mapped service URIs contains the the {datasource-name} path element.
  39  * The available {datasource-name}s are defined in a configuration file which
  40  * is loaded by the {@link UpdatableRoutingDataSource}. If the
  41  * UpdatableRoutingDataSource is not being used in the actual application
  42  * context any arbitrary {datasource-name} may be used.
  43  * <p>
  44  * Methods mapped at type level, inherited from super classes ({@link BaseController}):
  45  * <blockquote>
  46  * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;name&#x002F;{name-uuid}</b>
  47  *
  48  * Get the {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
  49  * The returned TaxonNameBase is initialized by
  50  * the following strategy: -- NONE --
  51  * </blockquote>
  52  *
  53  * @author a.kohlbecker
  54  * @date 24.03.2009
  55  */
  56
  57 @Controller
  58 @RequestMapping(value = {"/portal/name/{uuid}"})
  59 public class NamePortalController extends BaseController<TaxonNameBase, INameService>
  60 {
  61
  62     private static final List<String> TYPEDESIGNATION_INIT_STRATEGY = Arrays.asList(new String []{
  63             "typeName.$",
  64             "typeSpecimen",
  65             "typeStatus.representations",
  66             "typifiedNames",
  67             "citation.authorTeam.$",
  68             "typeSpecimen.media"
  69     });
  70
  71
  72     private static final List<String> NAMEDESCRIPTION_INIT_STRATEGY = Arrays.asList(new String []{
  73             "uuid",
  74             "feature",
  75             "elements.$",
  76             "elements.multilanguageText",
  77             "elements.media",
  78     });
  79
  80
  81 //      public NamePortalController(){
  82 //              super();
  83 //              setInitializationStrategy(Arrays.asList(new String[]{"$"})); //TODO required???
  84 //      }
  85
  86     /* (non-Javadoc)
  87      * @see eu.etaxonomy.cdm.remote.controller.GenericController#setService(eu.etaxonomy.cdm.api.service.IService)
  88      */
  89     @Autowired
  90     @Override
  91     public void setService(INameService service) {
  92         this.service = service;
  93     }
  94
  95     @Autowired
  96     private IDescriptionService descriptionService;
  97
  98     /**
  99      * Get the list of {@link TypeDesignationBase}s of the
 100      * {@link TaxonNameBase} instance identified by the <code>{name-uuid}</code>.
 101      * <p>
 102      * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;name&#x002F;{name-uuid}&#x002F;typeDesignations</b>
 103      *
 104      * @param request
 105      * @param response
 106      * @return a List of {@link TypeDesignationBase} entities which are initialized
 107      *         using the following initialization strategy:
 108      *         {@link #TYPEDESIGNATION_INIT_STRATEGY}
 109      * @throws IOException
 110      */
 111     @SuppressWarnings("unchecked")
 112     @RequestMapping(
 113             value = {"typeDesignations"},
 114             method = RequestMethod.GET)
 115     public ModelAndView doGetTypeDesignations(@PathVariable("uuid") UUID uuid,
 116             HttpServletRequest request, HttpServletResponse response)throws IOException {
 117         ModelAndView mv = new ModelAndView();
 118         TaxonNameBase tnb = getCdmBaseInstance(uuid, response, (List<String>)null);
 119         Pager<TypeDesignationBase> p = service.getTypeDesignations(tnb,  null, null, null, TYPEDESIGNATION_INIT_STRATEGY);
 120         mv.addObject(p.getRecords());
 121         return mv;
 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.getServletPath());
 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 }