EDIT

/**

* Copyright (C) 2007 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.Arrays;

import java.util.List;

import java.util.UUID;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;

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.PathVariable;

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

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

import org.springframework.web.servlet.ModelAndView;

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

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

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

import eu.etaxonomy.cdm.api.service.l10n.LocaleContext;

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

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

import eu.etaxonomy.cdm.model.description.DescriptionBase;

import eu.etaxonomy.cdm.model.description.Feature;

import eu.etaxonomy.cdm.model.description.TaxonDescription;

import eu.etaxonomy.cdm.model.description.TextData;

import eu.etaxonomy.cdm.model.location.NamedAreaLevel;

import eu.etaxonomy.cdm.model.term.TermTree;

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

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

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

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("description")

@RequestMapping(value = {"/description/{uuid}", "/description/{uuid_list}"})

public class DescriptionController extends AbstractIdentifiableController<DescriptionBase, IDescriptionService> {

    private static final Logger logger = Logger.getLogger(DescriptionController.class);

    @Autowired

    private ITermTreeService termTreeService;

    @Autowired

    private ITermService termService;

    protected static final List<String> TAXONDESCRIPTION_INIT_STRATEGY = Arrays.asList(new String []{

            "$",

            "descriptiveDataSets",

            "descriptiveDataSets.descriptiveSystem",

            "descriptiveDataSets.descriptiveSystem.root",

            "descriptiveDataSets.descriptiveSystem.root.childNodes",

            "descriptiveDataSets.descriptiveSystem.root.childNodes.term",

            "elements.$",

            "elements.sources.citation.authorship",

            "elements.sources.nameUsedInSource",

            "elements.multilanguageText",

            "elements.media",

    });

    @InitBinder

    @Override

    public void initBinder(WebDataBinder binder) {

        super.initBinder(binder);

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

        binder.registerCustomEditor(NamedAreaLevel.class, new NamedAreaLevelPropertyEditor());

        binder.registerCustomEditor(DefinedTermBaseList.class, new TermBaseListPropertyEditor<MarkerType>(termService));

    }

    @Autowired

    @Override

    public void setService(IDescriptionService service) {

        this.service = service;

    }

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

    public ModelAndView doHasStructuredData(

            @PathVariable("uuid") UUID uuid,

            HttpServletRequest request,

            HttpServletResponse response) throws IOException {

        logger.info("doHasStructuredData() - " + request.getRequestURI());

        ModelAndView mv = new ModelAndView();

        DescriptionBase<?> description = service.load(uuid);

        if(!(description instanceof TaxonDescription)){

            HttpStatusMessage.UUID_REFERENCES_WRONG_TYPE.send(response);

            // will terminate thread

        }

        boolean hasStructuredData = service.hasStructuredData(description);

        mv.addObject(hasStructuredData);

        return mv;

    }

    /*

    @RequestMapping(value = "{uuid_list}/namedAreaTree", method = RequestMethod.GET)

    public NamedAreaTree doGetOrderedDistributions(

            @PathVariable("uuid_list") UuidList descriptionUuidList,

            @RequestParam(value = "omitLevels", required = false) Set<NamedAreaLevel> levels,

            //@ModelAttribute("omitLevels") HashSet<NamedAreaLevel> levels,

            HttpServletRequest request, HttpServletResponse response) {

        logger.info("getOrderedDistributions(" + ObjectUtils.toString(levels) + ") - " + request.getRequestURI());

        Set<TaxonDescription> taxonDescriptions = new HashSet<TaxonDescription>();

        TaxonDescription description;

        for (UUID descriptionUuid : descriptionUuidList) {

            description = (TaxonDescription) service.load(descriptionUuid);

            taxonDescriptions.add(description);

        }

        NamedAreaTree areaTree = service.getOrderedDistributions(taxonDescriptions, levels);

        return areaTree;

    }

    */

    @RequestMapping(value = "naturalLanguageDescription/{termtree_uuid}", method = RequestMethod.GET) // mapped as absolute path, see CdmAntPathMatcher

    public ModelAndView doGenerateNaturalLanguageDescription(

            @PathVariable("uuid") UUID uuid,

            @PathVariable("termtree_uuid") UUID termTreeUuid,

            HttpServletRequest request,

            HttpServletResponse response) throws IOException {

        logger.info("doGenerateNaturalLanguageDescription() - " + request.getRequestURI());

        DescriptionBase<?> description = service.load(uuid);

        ModelAndView mv = new ModelAndView();

        List<Language> languages = LocaleContext.getLanguages();

        if(!(description instanceof TaxonDescription)){

            HttpStatusMessage.UUID_REFERENCES_WRONG_TYPE.send(response);

            // will terminate thread

        }

        TermTree termTree = termTreeService.load(termTreeUuid, null);

        if(termTree == null){

            HttpStatusMessage.UUID_NOT_FOUND.send(response);

            // will terminate thread

        }

        String naturalLanguageDescription = service.generateNaturalLanguageDescription(

                termTree,

                (TaxonDescription)description,

                languages,

                ", ");

        TextData textData = TextData.NewInstance(Feature.DESCRIPTION());

        textData.putText(Language.DEFAULT(), naturalLanguageDescription);

        mv.addObject(textData);

        return mv;

    }

}