EDIT

// $Id$

/**

 * 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.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 eu.etaxonomy.cdm.api.service.ITaxonService;

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

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

import eu.etaxonomy.cdm.database.UpdatableRoutingDataSource;

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

import eu.etaxonomy.cdm.model.name.Rank;

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

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

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

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

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

/**

 * The TaxonomicTreeController class is a Spring MVC Controller.

 * <p>

 * The syntax of the mapped service URIs contains the the {datasource-name} path element.

 * The available {datasource-name}s are defined in a configuration file which

 * is loaded by the {@link UpdatableRoutingDataSource}. If the

 * UpdatableRoutingDataSource is not being used in the actual application

 * context any arbitrary {datasource-name} may be used.

 * <p>

 * @author a.kohlbecker

 * @date 20.03.2009

 */

@Controller

public class TaxonomicTreePortalListController extends BaseListController<TaxonomicTree,ITaxonTreeService> {

	private static final List<String> TAXONTREE_INIT_STRATEGY = Arrays.asList(new String[]{

			"reference.authorTeam.titleCache"

	});

	private static final List<String> NODE_INIT_STRATEGY = Arrays.asList(new String[]{

			"taxon.sec", 

			"taxon.name.taggedName",

			"taxon.name.titleCache"

			});

	public static final Logger logger = Logger.getLogger(TaxonomicTreePortalListController.class);

	private ITaxonService taxonService;

	private ITaxonTreeService service;

	private ITermService termService;

	@Autowired

	public void setService(ITaxonTreeService service) {

		this.service = service; 

	}

	@Autowired

	public void setTermService(ITermService termService) {

		this.termService = termService;

	}

	@Autowired

	public void setTaxonService(ITaxonService taxonService) {

		this.taxonService = taxonService;

	}

	@InitBinder

    public void initBinder(WebDataBinder binder) {

		binder.registerCustomEditor(UUID.class, new UUIDPropertyEditor());

		binder.registerCustomEditor(Rank.class, new RankPropertyEditor());

	}

	/**

	 * Lists all available {@link TaxonomicTree}s.

	 * <p>

	 * URI: <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;taxontree</b>

	 * 

	 * @param request

	 * @param response

	 * @return a list of {@link TaxonomicTree}s initialized by

	 *         the {@link #TAXONTREE_INIT_STRATEGY}

	 * @throws IOException

	 */

	@RequestMapping(value = { "/portal/taxontree/" }, method = RequestMethod.GET)

	public List<TaxonomicTree> getTaxonomicTrees(HttpServletRequest request, HttpServletResponse response)

			throws IOException {

		logger.info("getTaxonomicTrees()");

		return service.list(null, null, null,null, TAXONTREE_INIT_STRATEGY);

	}

	/**

	 * @param treeUuid

	 * @param response

	 * @return

	 * @throws IOException

	 */

	@RequestMapping(

			value = {"/portal/taxontree/{treeUuid}/childNodes/"},

			method = RequestMethod.GET)

	public List<TaxonNode> getChildNodes(

			@PathVariable("treeUuid") UUID treeUuid,

			HttpServletResponse response

			) throws IOException {

		return getChildNodesAtRank(treeUuid, null, response);

	}

	@RequestMapping(

			value = {"/portal/taxontree/{treeUuid}/childNodesAt/{rankUuid}/"},

			method = RequestMethod.GET)

	public List<TaxonNode> getChildNodesAtRank(

			@PathVariable("treeUuid") UUID treeUuid,

			@PathVariable("rankUuid") UUID rankUuid,

			HttpServletResponse response

			) throws IOException {

		logger.info("getChildNodesAtRank()");

		TaxonomicTree tree = null;

		Rank rank = null;

		if(treeUuid != null){

			// get view and rank

			tree = service.find(treeUuid);

			if(tree == null) {

				response.sendError(404 , "TaxonomicTree not found using " + treeUuid );

				return null;

			}

		}

		rank = findRank(rankUuid);

		return service.loadRankSpecificRootNodes(tree, rank, NODE_INIT_STRATEGY);

	}

	/**

	 * Lists all child-{@link TaxonNode}s of the specified {@link Taxon} in the {@link TaxonomicTree}. The

	 * a given {@link Rank} is ignored in this method but for consistency reasons it has been allowed to included it into the URI. 

	 * <p>

	 * URI: <b>&#x002F;portal&#x002F;taxontree&#x002F;{treeUuid}&#x002F;childNodesOf&#x002F;{taxonUuid}</b>

	 * <p>

     * <b>URI elements:</b>

     * <ul>

     * <li><b>{tree-uuid}</b> identifies the {@link TaxonomicTree} by its UUID - <i>required</i>.

     * <li><b>{taxon-uuid}</b> identifies the {@link Taxon} by its UUID. - <i>required</i>.

     * </ul>

	 * 

	 * @param response

	 * @param request

	 * @return a List of {@link TaxonNode} entities initialized by

	 *         the {@link #NODE_INIT_STRATEGY}

	 */

	@RequestMapping(

			value = {"/portal/taxontree/{treeUuid}/childNodesOf/{taxonUuid}"}, 

			method = RequestMethod.GET)

	public List<TaxonNode> getChildNodesOfTaxon(

			@PathVariable("treeUuid") UUID treeUuid,

			@PathVariable("taxonUuid") UUID taxonUuid,

			HttpServletResponse response) throws IOException {

		logger.info("getChildNodesOfTaxon()");

		TaxonomicTree tree = service.find(treeUuid);

		Taxon taxon = (Taxon) taxonService.load(taxonUuid);

		List<TaxonNode> childs = service.loadChildNodesOfTaxon(taxon, tree, NODE_INIT_STRATEGY);

		return childs;

	}

	/**

	 * Provides path of {@link TaxonNode}s from the base node to the node of the specified taxon.

	 * <p>

	 * URI:<b>&#x002F;portal&#x002F;taxontree&#x002F;{treeUuid}&#x002F;pathFrom&#x002F;{taxonUuid}&#x002F;toRank&#x002F;{rankUuid}</b>

	 * <p>

     * <b>URI elements:</b>

     * <ul>

     * <li><b>{treeUuid}</b> identifies the {@link TaxonomicTree} by its UUID - <i>required</i>.

     * <li><b>{taxonUuid}</b> identifies the {@link Rank}

     * <li><b>{rankUuid}</b> identifies the {@link Taxon} by its UUID. - <i>required</i>.

     * </ul>

	 * 

	 * @param response

	 * @param request

	 * @return a List of {@link TaxonNode} entities initialized by

	 *         the {@link #NODE_INIT_STRATEGY}

	 */

	@RequestMapping(

			value = {"/portal/taxontree/{treeUuid}/pathFrom/{taxonUuid}/toRank/{rankUuid}"}, 

			method = RequestMethod.GET)

	public List<TaxonNode> getPathFromTaxonToRank(

			@PathVariable("treeUuid") UUID treeUuid,

			@PathVariable("taxonUuid") UUID taxonUuid,

			@PathVariable("rankUuid") UUID rankUuid,

			HttpServletRequest request,

			HttpServletResponse response) throws IOException {

		logger.info("getPathFromTaxonToRank(): " + request.getServletPath());

		TaxonomicTree tree = service.find(treeUuid);

		Rank rank = findRank(rankUuid);

		Taxon taxon = (Taxon) taxonService.load(taxonUuid);

		return service.loadTreeBranchToTaxon(taxon, tree, rank, NODE_INIT_STRATEGY);

	}

	/**

	 * Provides path of {@link TaxonNode}s from the base node to the node of the specified taxon.

	 * <p>

	 * URI:<b>&#x002F;portal&#x002F;taxontree&#x002F;{treeUuid}&#x002F;pathFrom&#x002F;{taxonUuid}</b>

	 * <p>

     * <b>URI elements:</b>

     * <ul>

     * <li><b>{treeUuid}</b> identifies the {@link TaxonomicTree} by its UUID - <i>required</i>.

     * <li><b>{rankUuid}</b> identifies the {@link Taxon} by its UUID. - <i>required</i>.

     * </ul>

	 * 

	 * @param response

	 * @param request

	 * @return a List of {@link TaxonNode} entities initialized by

	 *         the {@link #NODE_INIT_STRATEGY}

	 */

	@RequestMapping(

			value = {"/portal/taxontree/{treeUuid}/pathFrom/{taxonUuid}"}, 

			method = RequestMethod.GET)

	public List<TaxonNode> getPathFromTaxon(

			@PathVariable("treeUuid") UUID treeUuid,

			@PathVariable("taxonUuid") UUID taxonUuid,

			HttpServletRequest request,

			HttpServletResponse response) throws IOException {

		return getPathFromTaxonToRank(treeUuid, taxonUuid, null, request, response);

	}

	private Rank findRank(UUID rankUuid) {

		Rank rank = null;

		if(rankUuid != null){

			DefinedTermBase dt =  termService.find(rankUuid);

			if(dt instanceof Rank){

				rank = (Rank)dt;

			} else {

			   new IllegalArgumentException("DefinedTermBase is not a Rank");

			}

		}

		return rank;

	}

}