cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/controller/TaxonController.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.ArrayList;
  15 import java.util.Arrays;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Set;
  19 import java.util.UUID;
  20
  21 import javax.servlet.http.HttpServletRequest;
  22 import javax.servlet.http.HttpServletResponse;
  23
  24 import org.apache.log4j.Logger;
  25 import org.springframework.beans.factory.annotation.Autowired;
  26 import org.springframework.stereotype.Controller;
  27 import org.springframework.web.bind.annotation.PathVariable;
  28 import org.springframework.web.bind.annotation.RequestMapping;
  29 import org.springframework.web.bind.annotation.RequestMethod;
  30 import org.springframework.web.servlet.ModelAndView;
  31
  32 import eu.etaxonomy.cdm.api.service.INameService;
  33 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  34 import eu.etaxonomy.cdm.api.service.ITaxonService;
  35 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  36 import eu.etaxonomy.cdm.model.taxon.Synonym;
  37 import eu.etaxonomy.cdm.model.taxon.Taxon;
  38 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  39 import eu.etaxonomy.cdm.model.taxon.TaxonNode;
  40 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  41 import eu.etaxonomy.cdm.persistence.query.OrderHint.SortOrder;
  42
  43 /**
  44  * TODO write controller documentation
  45  *
  46  * @author a.kohlbecker
  47  * @date 20.07.2009
  48  *
  49  */
  50 @Controller
  51 @RequestMapping(value = {"/taxon/{uuid}"})
  52 public class TaxonController extends BaseController<TaxonBase, ITaxonService>
  53 {
  54     public static final Logger logger = Logger.getLogger(TaxonController.class);
  55
  56     @Autowired
  57     private IOccurrenceService occurrenceService;
  58     @Autowired
  59     private INameService nameService;
  60
  61     protected static final List<String> TAXONNODE_INIT_STRATEGY = Arrays.asList(new String []{
  62             "taxonNodes"
  63     });
  64
  65     public TaxonController(){
  66         super();
  67         setInitializationStrategy(Arrays.asList(new String[]{"$","name.nomenclaturalReference"}));
  68     }
  69
  70
  71     @Autowired
  72     public void setService(ITaxonService service) {
  73         this.service = service;
  74     }
  75
  76
  77     /**
  78      * Get the set of accepted {@link Taxon} entities for a given
  79      * {@link TaxonBase} entity identified by the <code>{taxon-uuid}</code>.
  80      * <p>
  81      * URI: <b>&#x002F;{datasource-name}&#x002F;taxon&#x002F;{taxon-uuid}&#x002F;accepted</b>
  82      *
  83      * @param request
  84      * @param response
  85      * @return a set on a list of {@link Taxon} entities which are initialized
  86      *         using the following initialization strategy:
  87      *         {@link #DEFAULT_INIT_STRATEGY}
  88      * @throws IOException
  89      */
  90     @RequestMapping(value = "accepted", method = RequestMethod.GET)
  91     public Set<TaxonBase> doGetAccepted(
  92             @PathVariable("uuid") UUID uuid,
  93             HttpServletRequest request,
  94             HttpServletResponse response) throws IOException {
  95         logger.info("getAccepted() " + request.getServletPath());
  96         TaxonBase tb = service.load(uuid);
  97         HashSet<TaxonBase> resultset = new HashSet<TaxonBase>();
  98         if(tb instanceof Taxon){
  99             //the taxon already is accepted
 100             //FIXME take the current view into account once views are implemented!!!
 101             resultset.add((Taxon)tb);
 102         } else {
 103             Synonym syn = (Synonym)tb;
 104             resultset.addAll(syn.getAcceptedTaxa());
 105             //TODO init Synonyms
 106         }
 107         return resultset;
 108     }
 109
 110     @RequestMapping(value = "taxonNodes", method = RequestMethod.GET)
 111     public Set<TaxonNode>  doGetTaxonNodes(
 112             @PathVariable("uuid") UUID uuid,
 113             HttpServletRequest request,
 114             HttpServletResponse response) throws IOException {
 115         TaxonBase tb = service.load(uuid, TAXONNODE_INIT_STRATEGY);
 116         if(tb instanceof Taxon){
 117             return ((Taxon)tb).getTaxonNodes();
 118         } else {
 119             HttpStatusMessage.UUID_REFERENCES_WRONG_TYPE.send(response);
 120             return null;
 121         }
 122     }
 123
 124     @RequestMapping(value = "specimensOrObersvations", method = RequestMethod.GET)
 125     public ModelAndView doListSpecimensOrObersvations(
 126             @PathVariable("uuid") UUID uuid,
 127             HttpServletRequest request,
 128             HttpServletResponse response) throws IOException {
 129         logger.info("doListSpecimensOrObersvations() - " + request.getServletPath());
 130
 131         ModelAndView mv = new ModelAndView();
 132
 133         TaxonBase tb = service.load(uuid);
 134
 135         List<OrderHint> orderHints = new ArrayList<OrderHint>();
 136         orderHints.add(new OrderHint("titleCache", SortOrder.DESCENDING));
 137
 138         if(tb instanceof Taxon){
 139             List<SpecimenOrObservationBase> specimensOrObersvations = occurrenceService.listByAnyAssociation(
 140                     null, (Taxon)tb, null, 0, orderHints, null);
 141             mv.addObject(specimensOrObersvations);
 142         } else {
 143             HttpStatusMessage.UUID_REFERENCES_WRONG_TYPE.send(response);
 144             return null;
 145         }
 146
 147         return mv;
 148     }
 149
 150     @RequestMapping(value = "taggedName", method = RequestMethod.GET)
 151     public ModelAndView doGetTaggedName(
 152             @PathVariable("uuid") UUID uuid,
 153             HttpServletRequest request,
 154             HttpServletResponse response) throws IOException {
 155         logger.info("doGetDescriptionElementsByType() - " + request.getServletPath());
 156
 157         ModelAndView mv = new ModelAndView();
 158
 159         TaxonBase tb = service.load(uuid, Arrays.asList(new String[] {"name"}));
 160         mv.addObject(nameService.getTaggedName(tb.getName().getUuid()));
 161         return mv;
 162     }
 163
 164 }