EDIT

/**

 * Copyright (C) 2009 EDIT European Distributed Institute of Taxonomy

 * http://www.e-taxonomy.eu

 *

 * The contents of this file are subject to the Mozilla Public License Version

 * 1.1 See LICENSE.TXT at the top of this package for the full license terms.

 */

package eu.etaxonomy.cdm.remote.controller;

import java.io.IOException;

import java.util.List;

import java.util.Set;

import java.util.UUID;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.hibernate.search.spatial.impl.Rectangle;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.WebDataBinder;

import org.springframework.web.bind.annotation.InitBinder;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;

import eu.etaxonomy.cdm.api.service.IOccurrenceService;

import eu.etaxonomy.cdm.api.service.ITaxonService;

import eu.etaxonomy.cdm.api.service.ITermService;

import eu.etaxonomy.cdm.api.service.dto.SpecimenOrObservationBaseDTO;

import eu.etaxonomy.cdm.api.service.pager.Pager;

import eu.etaxonomy.cdm.api.service.search.LuceneParseException;

import eu.etaxonomy.cdm.api.service.search.SearchResult;

import eu.etaxonomy.cdm.api.util.TaxonRelationshipEdge;

import eu.etaxonomy.cdm.model.common.Language;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

import eu.etaxonomy.cdm.model.taxon.Taxon;

import eu.etaxonomy.cdm.persistence.query.OrderHint;

import eu.etaxonomy.cdm.remote.controller.util.ControllerUtils;

import eu.etaxonomy.cdm.remote.controller.util.PagerParameters;

import eu.etaxonomy.cdm.remote.editor.RectanglePropertyEditor;

import eu.etaxonomy.cdm.remote.editor.UUIDListPropertyEditor;

import eu.etaxonomy.cdm.remote.editor.UuidList;

import io.swagger.annotations.Api;

/**

 * TODO write controller documentation

 *

 * @author a.kohlbecker

 * @since 24.03.2009

 */

@Controller

@Api("occurrence")

@RequestMapping(value = {"/occurrence"})

public class OccurrenceListController extends AbstractIdentifiableListController<SpecimenOrObservationBase, IOccurrenceService> {

    @Autowired

    private ITaxonService taxonService;

    @Autowired

    private ITermService termService;

    @Override

    @Autowired

    public void setService(IOccurrenceService service) {

        this.service = service;

    }

    @InitBinder

    @Override

    public void initBinder(WebDataBinder binder) {

        super.initBinder(binder);

        binder.registerCustomEditor(UuidList.class, new UUIDListPropertyEditor());

        binder.registerCustomEditor(Rectangle.class, new RectanglePropertyEditor());

    }

    /**

     * @param taxonUuid

     * @param relationshipUuids a comma separated list of uuids e.g. CongruentTo;  "60974c98-64ab-4574-bb5c-c110f6db634d"

     * @param relationshipInversUuids a comma separated list of uuids

     * @param maxDepth null for unlimited

     * @param pageNumber

     * @param pageSize

     * @param request

     * @param response

     * @return

     * @throws IOException

     */

    @RequestMapping(

            value = {"byAssociatedTaxon"},

            method = RequestMethod.GET)

    public Pager<SpecimenOrObservationBase> doListByAssociatedTaxon(

                @RequestParam(value = "taxonUuid", required = true) UUID taxonUuid,

                @RequestParam(value = "relationships", required = false) UuidList relationshipUuids,

                @RequestParam(value = "relationshipsInvers", required = false) UuidList relationshipInversUuids,

                @RequestParam(value = "maxDepth", required = false) Integer maxDepth,

                @RequestParam(value = "pageNumber", required = false) Integer pageNumber,

                @RequestParam(value = "pageSize", required = false) Integer pageSize,

                HttpServletRequest request,

                HttpServletResponse response) throws IOException {

        logger.info("doListByAssociatedTaxon()" + requestPathAndQuery(request));

        Set<TaxonRelationshipEdge> includeRelationships = ControllerUtils.loadIncludeRelationships(relationshipUuids, relationshipInversUuids, termService);

        Taxon associatedTaxon = (Taxon) taxonService.find(taxonUuid);

        PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);

        pagerParams.normalizeAndValidate(response);

        List<OrderHint> orderHints = null;

        return service.pageByAssociatedTaxon(null, includeRelationships, associatedTaxon,

                maxDepth, pagerParams.getPageSize(), pagerParams.getPageIndex(),

                orderHints, getInitializationStrategy());

    }

    @RequestMapping(value = "rootUnitDTOsByAssociatedTaxon", method = RequestMethod.GET)

    public List<SpecimenOrObservationBaseDTO> doListlistRootUnitDTOsByAssociatedTaxon(

            @RequestParam(value = "uuid", required = true) UUID uuid,

            HttpServletRequest request,

            HttpServletResponse response) {

        logger.info("doListlistRootUnitDTOByAssociatedTaxon() - " + requestPathAndQuery(request));

        List<SpecimenOrObservationBaseDTO> sobDTOs = service.listRootUnitDTOsByAssociatedTaxon(null, uuid, OccurrenceController.DERIVED_UNIT_INIT_STRATEGY);

        return sobDTOs;

    }

    /**

     *

     * @param clazz

     * @param queryString

     * @param boundingBox

     *            as

     *            minx(minlongitute),miny(minlatitute),maxx(maxlongitute),max(

     *            maxlatitute), e.g. 13.112,52.374,13.681,52.641 for the Berlin

     *            area

     * @param languages

     * @param highlighting

     * @param pageNumber

     * @param pageSize

     * @param request

     * @param response

     * @return

     * @throws IOException

     * @throws ParseException

     */

    @RequestMapping(method = RequestMethod.GET, value={"findByFullText"})

    public Pager<SearchResult<SpecimenOrObservationBase>> doFindByFullText(

            @RequestParam(value = "clazz", required = false) Class<? extends SpecimenOrObservationBase<?>> clazz,

            @RequestParam(value = "query", required = false) String queryString,

            @RequestParam(value = "bbox", required = false) Rectangle boundingBox,

            @RequestParam(value = "languages", required = false) List<Language> languages,

            @RequestParam(value = "hl", required = false) Boolean highlighting,

            @RequestParam(value = "pageNumber", required = false) Integer pageNumber,

            @RequestParam(value = "pageSize", required = false) Integer pageSize,

            HttpServletRequest request,

            HttpServletResponse response

            )

             throws IOException, LuceneParseException {

         logger.info("doFindByFullText() " + requestPathAndQuery(request) );

         PagerParameters pagerParams = new PagerParameters(pageSize, pageNumber);

         pagerParams.normalizeAndValidate(response);

         if(highlighting == null){

             highlighting = false;

         }

         if(queryString == null && boundingBox == null) {

             HttpStatusMessage.create("Either query or bbox must be given", 400).send(response);

             return null;

         }

        Pager<SearchResult<SpecimenOrObservationBase>> pager = service.findByFullText(clazz, queryString, boundingBox, languages,

                highlighting, pagerParams.getPageSize(), pagerParams.getPageIndex(), ((List<OrderHint>)null),

                initializationStrategy);

        return pager;

    }

    @RequestMapping(method = RequestMethod.GET, value = "byGeneticAccessionNumber" )

    public SpecimenOrObservationBaseDTO doGetByGeneticAccessionNumber(

            @RequestParam(value="accessionNumber", required = true) String accessionNumber,

            HttpServletRequest request,

            HttpServletResponse response) throws IOException {

        logger.info("doGetByGeneticAccessionNumber() - " + requestPathAndQuery(request));

       SpecimenOrObservationBaseDTO sobDto = service.findByGeneticAccessionNumber(accessionNumber, null);

       if(sobDto == null ) {

           response.setHeader("Failure", "No DNA available for accession number ");

           HttpStatusMessage.create("No DNA available for accession number " + accessionNumber, 400).send(response);

           return null;

       }

       return sobDto;

    }

}