EDIT

// $Id: TaxonController.java 5473 2009-03-25 13:42:07Z a.kohlbecker $

/**

* 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.ArrayList;

import java.util.Arrays;

import java.util.HashSet;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.ObjectUtils;

import org.apache.http.HttpRequest;

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.bind.annotation.RequestParam;

import org.springframework.web.servlet.ModelAndView;

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

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

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

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

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

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

import eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator;

import eu.etaxonomy.cdm.api.service.config.TaxonServiceConfiguratorImpl;

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

import eu.etaxonomy.cdm.database.UpdatableRoutingDataSource;

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

import eu.etaxonomy.cdm.model.common.RelationshipBase.Direction;

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

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

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

import eu.etaxonomy.cdm.model.media.Media;

import eu.etaxonomy.cdm.model.media.MediaRepresentationPart;

import eu.etaxonomy.cdm.model.media.MediaUtils;

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

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

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

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

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

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

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

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

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

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

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

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

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

/**

 * The TaxonPortalController 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>

 * Methods mapped at type level, inherited from super classes ({@link BaseController}):

 * <blockquote>

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

 *

 * Get the {@link TaxonBase} instance identified by the <code>{taxon-uuid}</code>.

 * The returned Taxon is initialized by

 * the following strategy {@link #TAXON_INIT_STRATEGY}

 * </blockquote>

 *

 * @author a.kohlbecker

 * @date 20.07.2009

 *

 */

@Controller

@RequestMapping(value = {"/portal/taxon/{uuid}"})

public class TaxonPortalController extends BaseController<TaxonBase, ITaxonService>

{

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

    @Autowired

    private INameService nameService;

    @Autowired

    private IDescriptionService descriptionService;

    @Autowired

    private IOccurrenceService occurrenceService;

    @Autowired

    private IClassificationService classificationService;

    @Autowired

    private ITaxonService taxonService;

    @Autowired

    private IFeatureTreeService featureTreeService;

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

            "*",

            // taxon relations

            "relationsToThisName.fromTaxon.name",

            // the name

            "name.$",

            "name.rank.representations",

            "name.status.type.representations",

            // taxon descriptions

            "descriptions.elements.area.$",

            "descriptions.elements.multilanguageText",

            "descriptions.elements.media.representations.parts",

            "descriptions.elements.media.title",

            });

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

            "taxonNodes.$",

            "taxonNodes.classification.$",

            "taxonNodes.childNodes.$"

            });

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

            "*",

            // taxon relations

            "relationsToThisName.fromTaxon.name",

            // the name

            "name.$",

            "name.rank.representations",

            "name.status.type.representations",

            "name.nomenclaturalReference"

            });

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

            // initialize homotypical and heterotypical groups; needs synonyms

            "synonymRelations.$",

            "synonymRelations.synonym.$",

            "synonymRelations.synonym.name.status.type.representation",

            "synonymRelations.synonym.name.nomenclaturalReference.inReference",

            "synonymRelations.synonym.name.homotypicalGroup.typifiedNames.$",

            "synonymRelations.synonym.name.homotypicalGroup.typifiedNames.taxonBases.$",

            "synonymRelations.synonym.name.combinationAuthorTeam.$",

            "name.typeDesignations",

            "name.homotypicalGroup.$",

            "name.homotypicalGroup.typifiedNames.$",

            "name.homotypicalGroup.typifiedNames.nomenclaturalReference.authorTeam",

            "name.homotypicalGroup.typifiedNames.taxonBases.$"

    });

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

            // initialize homotypical and heterotypical groups; needs synonyms

            "synonymRelations.$",

            "synonymRelations.synonym.$",

            "synonymRelations.synonym.name.status.type.representation",

            "synonymRelations.synonym.name.nomenclaturalReference.inReference",

            "synonymRelations.synonym.name.homotypicalGroup.typifiedNames.$",

            "synonymRelations.synonym.name.homotypicalGroup.typifiedNames.taxonBases.$",

            "synonymRelations.synonym.name.combinationAuthorTeam.$",

            "name.homotypicalGroup.$",

            "name.homotypicalGroup.typifiedNames.$",

            "name.homotypicalGroup.typifiedNames.nomenclaturalReference.authorTeam",

            "name.homotypicalGroup.typifiedNames.taxonBases.$",

            "taxonNodes.$",

            "taxonNodes.classification.$",

            "taxonNodes.childNodes.$"

    });

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

            "*",

            // taxon relations

            "relationsToThisName.fromTaxon.name",

            // the name

            "name.$",

            "name.rank.representations",

            "name.status.type.representations",

            "name.nomenclaturalReference",

            "taxonNodes.$",

            "taxonNodes.classification.$",

            "taxonNodes.childNodes.$"

            });

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

            "$",

            "type.inverseRepresentations",

            "fromTaxon.sec",

            "fromTaxon.name"

    });

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

            "$",

            "type.inverseRepresentations",

            "fromName",

            "toName.$",

    });

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

            "$",

            "elements.$",

            "elements.sources.citation.authorTeam",

            "elements.sources.nameUsedInSource.originalNameString",

            "elements.multilanguageText",

            "elements.media.representations.parts",

            "elements.media.title",

    });

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

            "$",

            "sources.citation.authorTeam",

            "sources.nameUsedInSource.originalNameString",

            "multilanguageText",

            "media.representations.parts",

            "media.title",

    });

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

//			"uuid",

//			"feature",

//			"elements.$",

//			"elements.multilanguageText",

//			"elements.media.representations.parts",

//			"elements.media.title",

//	});

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

            "elements.media.representations.parts",

            "elements.media.title"

    });

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

            //"$",

            "typeSpecimen.$",

            "citation.authorTeam.$",

            "typeName",

    });

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

            "childNodes.taxon",

    });

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

            "taxonNodes.classification"

    });

    private static final String featureTreeUuidPattern = "^/taxon(?:(?:/)([^/?#&\\.]+))+.*";

    public TaxonPortalController(){

        super();

        setInitializationStrategy(TAXON_INIT_STRATEGY);

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.cdm.remote.controller.GenericController#setService(eu.etaxonomy.cdm.api.service.IService)

     */

    @Autowired

    @Override

    public void setService(ITaxonService service) {

        this.service = service;

    }

    @InitBinder

    @Override

    public void initBinder(WebDataBinder binder) {

        super.initBinder(binder);

        binder.registerCustomEditor(NamedArea.class, new NamedAreaPropertyEditor());

        binder.registerCustomEditor(MatchMode.class, new MatchModePropertyEditor());

        binder.registerCustomEditor(Class.class, new CdmTypePropertyEditor());

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.cdm.remote.controller.BaseController#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

    @Override

    @RequestMapping(method = RequestMethod.GET)

    public TaxonBase doGet(HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGet()");

        TaxonBase tb = getCdmBase(request, response, TAXON_INIT_STRATEGY, TaxonBase.class);

        return tb;

    }

     */

    /**

     * Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.

     * <p>

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

     *

     * @param query

     *            the string to query for. Since the wildcard character '*'

     *            internally always is appended to the query string, a search

     *            always compares the query string with the beginning of a name.

     *            - <i>required parameter</i>

     * @param treeUuid

     *            the {@link UUID} of a {@link Classification} to which the

     *            search is to be restricted. - <i>optional parameter</i>

     * @param areas

     *            restrict the search to a set of geographic {@link NamedArea}s.

     *            The parameter currently takes a list of TDWG area labels.

     *            - <i>optional parameter</i>

     * @param pageNumber

     *            the number of the page to be returned, the first page has the

     *            pageNumber = 1 - <i>optional parameter</i>

     * @param pageSize

     *            the maximum number of entities returned per page (can be -1

     *            to return all entities in a single page) - <i>optional parameter</i>

     * @param doTaxa

     *            weather to search for instances of {@link Taxon} - <i>optional parameter</i>

     * @param doSynonyms

     *            weather to search for instances of {@link Synonym} - <i>optional parameter</i>

     * @param doTaxaByCommonNames

     *            for instances of {@link Taxon} by a common name used - <i>optional parameter</i>

     * @param matchMode

     *           valid values are "EXACT", "BEGINNING", "ANYWHERE", "END" (case sensitive !!!)

     * @return a Pager on a list of {@link IdentifiableEntity}s initialized by

     *         the following strategy {@link #SIMPLE_TAXON_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(method = RequestMethod.GET,

            value = {"/portal/taxon/find"}) //TODO map to path /*/portal/taxon/

    public Pager<IdentifiableEntity> doFind(

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

            @RequestParam(value = "tree", required = false) UUID treeUuid,

            @RequestParam(value = "area", required = false) Set<NamedArea> areas,

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

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

            @RequestParam(value = "doTaxa", required = false) Boolean doTaxa,

            @RequestParam(value = "doSynonyms", required = false) Boolean doSynonyms,

            @RequestParam(value = "doTaxaByCommonNames", required = false) Boolean doTaxaByCommonNames,

            @RequestParam(value = "matchMode", required = false) MatchMode matchMode,

            HttpServletRequest request,

            HttpServletResponse response

            )

             throws IOException {

        logger.info("doFind : " + request.getRequestURI() + request.getQueryString() );

        BaseListController.normalizeAndValidatePagerParameters(pageNumber, pageSize, response);

        ITaxonServiceConfigurator config = new TaxonServiceConfiguratorImpl();

        config.setPageNumber(pageNumber);

        config.setPageSize(pageSize);

        config.setTitleSearchString(query);

        config.setDoTaxa(doTaxa!= null ? doTaxa : Boolean.FALSE );

        config.setDoSynonyms(doSynonyms != null ? doSynonyms : Boolean.FALSE );

        config.setDoTaxaByCommonNames(doTaxaByCommonNames != null ? doTaxaByCommonNames : Boolean.FALSE );

        config.setMatchMode(matchMode != null ? matchMode : MatchMode.BEGINNING);

        config.setTaxonPropertyPath(SIMPLE_TAXON_INIT_STRATEGY);

        config.setNamedAreas(areas);

        if(treeUuid != null){

            Classification classification = classificationService.find(treeUuid);

            config.setClassification(classification);

        }

        return (Pager<IdentifiableEntity>) service.findTaxaAndNames(config);

    }

    /**

     * Get the synonymy for a taxon identified by the <code>{taxon-uuid}</code>.

     * The synonymy consists

     * of two parts: The group of homotypic synonyms of the taxon and the

     * heterotypic synonymy groups of the taxon. The synonymy is ordered

     * historically by the type designations and by the publication date of the

     * nomenclatural reference

     * <p>

     * URI:

     * <b>&#x002F;{datasource-name}&#x002F;portal&#x002F;taxon&#x002F;{taxon-uuid}&#x002F;synonymy</b>

     *

     *

     * @param request

     * @param response

     * @return a Map with to entries which are mapped by the following keys:

     *         "homotypicSynonymsByHomotypicGroup", "heterotypicSynonymyGroups",

     *         containing lists of {@link Synonym}s which are initialized using the

     *         following initialization strategy: {@link #SYNONYMY_INIT_STRATEGY}

     *

     * @throws IOException

     */

    @RequestMapping(

            value = {"synonymy"},

            method = RequestMethod.GET)

    public ModelAndView doGetSynonymy(@PathVariable("uuid") UUID uuid,

            HttpServletRequest request, HttpServletResponse response)throws IOException {

        if(request != null){

            logger.info("doGetSynonymy() " + request.getServletPath());

        }

        ModelAndView mv = new ModelAndView();

        Taxon taxon = getCdmBaseInstance(Taxon.class, uuid, response, (List<String>)null);

        Map<String, List<?>> synonymy = new Hashtable<String, List<?>>();

        synonymy.put("homotypicSynonymsByHomotypicGroup", service.getHomotypicSynonymsByHomotypicGroup(taxon, SYNONYMY_INIT_STRATEGY));

        synonymy.put("heterotypicSynonymyGroups", service.getHeterotypicSynonymyGroups(taxon, SYNONYMY_INIT_STRATEGY));

        mv.addObject(synonymy);

        return mv;

    }

    /**

     * Get the set of accepted {@link Taxon} entities for a given

     * {@link TaxonBase} entity identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a Set of {@link Taxon} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #SYNONYMY_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(value = "accepted/{classification_uuid}", method = RequestMethod.GET)

    public Set<TaxonBase> getAccepted(

                @PathVariable("uuid") UUID uuid,

                @PathVariable("classification_uuid") UUID classification_uuid,

                HttpServletRequest request,

                HttpServletResponse response)

                throws IOException {

        if(request != null){

            logger.info("getAccepted() " + request.getServletPath());

        }

        TaxonBase tb = service.load(uuid, SYNONYMY_WITH_NODES_INIT_STRATEGY);

        if(tb == null){

            response.sendError(HttpServletResponse.SC_NOT_FOUND, "A taxon with the uuid " + uuid + " does not exist");

            return null;

        }

        HashSet<TaxonBase> resultset = new HashSet<TaxonBase>();

        if (tb instanceof Taxon){

            Taxon taxon = (Taxon) tb;

            Set<TaxonNode> nodes = taxon.getTaxonNodes();

            for (TaxonNode taxonNode : nodes) {

                if (taxonNode.getClassification().compareTo(classification_uuid) == 0){

                    resultset.add((Taxon) tb);

                }

            }

            if (resultset.size() > 1){

                //error!! A taxon is not allow to have more taxonnodes for a given classification

                response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,

                "A taxon with the uuid " + uuid + " has more than one taxon node for the given classification" + classification_uuid);

            }

        }else{

            Synonym syn = (Synonym) tb;

            for(TaxonBase accepted : syn.getAcceptedTaxa()){

                tb = service.load(accepted.getUuid(), SIMPLE_TAXON_WITH_NODES_INIT_STRATEGY);

                if (tb instanceof Taxon){

                    Taxon taxon = (Taxon) tb;

                    Set<TaxonNode> nodes = taxon.getTaxonNodes();

                    for (TaxonNode taxonNode : nodes) {

                        if (taxonNode.getClassification().compareTo(classification_uuid) == 0){

                            resultset.add((Taxon) tb);

                        }

                    }

                    if (resultset.size() > 1){

                        //error!! A taxon is not allow to have more taxonnodes for a given classification

                        response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,

                        "A taxon with the uuid " + uuid + " has more than one taxon node for the given classification" + classification_uuid);

                    }

                }else{

                    //ERROR!! perhaps missapplied name????

                    //syn.getRelationType((Taxon)accepted);

                }

            }

        }

/**

 * OLD CODE!!

        if(tb instanceof Taxon){

            //the taxon already is accepted

            //FIXME take the current view into account once views are implemented!!!

            resultset.add((Taxon)tb);

        } else {

            Synonym syn = (Synonym)tb;

            for(TaxonBase accepted : syn.getAcceptedTaxa()){

                accepted = service.load(accepted.getUuid(), SIMPLE_TAXON_INIT_STRATEGY);

                resultset.add(accepted);

            }

        }

*/

        return resultset;

    }

    /**

     * Get the list of {@link TaxonRelationship}s for the given

     * {@link TaxonBase} instance identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a List of {@link TaxonRelationship} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #TAXONRELATIONSHIP_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(

            value = {"taxonRelationships"},

            method = RequestMethod.GET)

    public List<TaxonRelationship> doGetTaxonRelations(@PathVariable("uuid") UUID uuid,

            HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGetTaxonRelations()" + request.getServletPath());

        Taxon taxon = getCdmBaseInstance(Taxon.class, uuid, response, (List<String>)null);

        List<TaxonRelationship> relations = new ArrayList<TaxonRelationship>();

        List<TaxonRelationship> results = service.listToTaxonRelationships(taxon, TaxonRelationshipType.MISAPPLIED_NAME_FOR(), null, null, null, TAXONRELATIONSHIP_INIT_STRATEGY);

        relations.addAll(results);

        results = service.listToTaxonRelationships(taxon, TaxonRelationshipType.INVALID_DESIGNATION_FOR(), null, null, null, TAXONRELATIONSHIP_INIT_STRATEGY);

        relations.addAll(results);

        return relations;

    }

    /**

     * Get the list of {@link NameRelationship}s of the Name associated with the

     * {@link TaxonBase} instance identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a List of {@link NameRelationship} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #NAMERELATIONSHIP_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(

            value = {"toNameRelationships"},

            method = RequestMethod.GET)

    public List<NameRelationship> doGetToNameRelations(@PathVariable("uuid") UUID uuid,

            HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGetNameRelations()" + request.getServletPath());

        TaxonBase taxonBase = getCdmBaseInstance(TaxonBase.class, uuid, response, (List<String>)null);

        List<NameRelationship> list = nameService.listNameRelationships(taxonBase.getName(), Direction.relatedTo, null, null, 0, null, NAMERELATIONSHIP_INIT_STRATEGY);

        //List<NameRelationship> list = nameService.listToNameRelationships(taxonBase.getName(), null, null, null, null, NAMERELATIONSHIP_INIT_STRATEGY);

        return list;

    }

    /**

     * Get the list of {@link NameRelationship}s of the Name associated with the

     * {@link TaxonBase} instance identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a List of {@link NameRelationship} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #NAMERELATIONSHIP_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(

            value = {"fromNameRelationships"},

            method = RequestMethod.GET)

    public List<NameRelationship> doGetFromNameRelations(@PathVariable("uuid") UUID uuid,

            HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGetNameFromNameRelations()" + request.getServletPath());

        TaxonBase taxonbase = getCdmBaseInstance(TaxonBase.class, uuid, response, SIMPLE_TAXON_INIT_STRATEGY);

        List<NameRelationship> list = nameService.listNameRelationships(taxonbase.getName(), Direction.relatedFrom, null, null, 0, null, NAMERELATIONSHIP_INIT_STRATEGY);

        //List<NameRelationship> list = nameService.listFromNameRelationships(taxonbase.getName(), null, null, null, null, NAMERELATIONSHIP_INIT_STRATEGY);

        return list;

    }

    /**

     * Get the list of {@link TypeDesignationBase}s of the

     * {@link TaxonBase} instance identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a List of {@link TypeDesignationBase} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #TYPEDESIGNATION_INIT_STRATEGY}

     * @throws IOException

     * @Deprecated use /name/{uuid}/typeDesignations & /derivedunitfacade/{uuid} instead

     * also see http://dev.e-taxonomy.eu/trac/ticket/2280

     */

    @Deprecated

    @RequestMapping(

            value = {"nameTypeDesignations"},

            method = RequestMethod.GET)

    public List<TypeDesignationBase> doGetNameTypeDesignations(@PathVariable("uuid") UUID uuid,

            HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGetNameTypeDesignations()" + request.getServletPath());

        Taxon taxon = getCdmBaseInstance(Taxon.class, uuid, response, SIMPLE_TAXON_INIT_STRATEGY);

        Pager<TypeDesignationBase> p = nameService.getTypeDesignations(taxon.getName(), null, null, null, TYPEDESIGNATION_INIT_STRATEGY);

        return p.getRecords();

    }

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

    public Set<TaxonNode>  doGetTaxonNodes(

            @PathVariable("uuid") UUID uuid,

            HttpServletRequest request,

            HttpServletResponse response) throws IOException {

        TaxonBase tb = service.load(uuid, TAXONNODE_INIT_STRATEGY);

        if(tb instanceof Taxon){

            return ((Taxon)tb).getTaxonNodes();

        } else {

            HttpStatusMessage.UUID_REFERENCES_WRONG_TYPE.send(response);

            return null;

        }

    }

    /**

     * Get the list of {@link TaxonDescription}s of the

     * {@link Taxon} instance identified by the <code>{taxon-uuid}</code>.

     * <p>

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

     *

     * @param request

     * @param response

     * @return a List of {@link TaxonDescription} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #TAXONDESCRIPTION_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(

            value = {"descriptions"},

            method = RequestMethod.GET)

    public List<TaxonDescription> doGetDescriptions(

            @PathVariable("uuid") UUID uuid,

            HttpServletRequest request,

            HttpServletResponse response)throws IOException {

        if(request != null){

            logger.info("doGetDescriptions()" + request.getServletPath());

        }

        Taxon t = getCdmBaseInstance(Taxon.class, uuid, response, (List<String>)null);

        Pager<TaxonDescription> p = descriptionService.getTaxonDescriptions(t, null, null, null, null, TAXONDESCRIPTION_INIT_STRATEGY);

        return p.getRecords();

    }

    @RequestMapping(value = "descriptions/elementsByType/{classSimpleName}", method = RequestMethod.GET)

    public ModelAndView doGetDescriptionElementsByType(

            @PathVariable("uuid") UUID uuid,

            @PathVariable("classSimpleName") String classSimpleName,

            @RequestParam(value = "count", required = false, defaultValue = "false") Boolean doCount,

            HttpServletRequest request,

            HttpServletResponse response) throws IOException {

        logger.info("doGetDescriptionElementsByType() - " + request.getServletPath());

        ModelAndView mv = new ModelAndView();

        List<DescriptionElementBase> allElements = new ArrayList<DescriptionElementBase>();

        List<DescriptionElementBase> elements;

        int count = 0;

        List<String> initStrategy = doCount ? null : DESCRIPTION_ELEMENT_INIT_STRATEGY;

        List<TaxonDescription> taxonDescriptions = doGetDescriptions(uuid, request, response);

        try {

            Class type;

            type = Class.forName("eu.etaxonomy.cdm.model.description."

                    + classSimpleName);

            if (taxonDescriptions != null) {

                for (TaxonDescription description : taxonDescriptions) {

                    elements = descriptionService.listDescriptionElements(description, null, type, null, 0, initStrategy);

                    allElements.addAll(elements);

                    count += elements.size();

                }

            }

        } catch (ClassNotFoundException e) {

            HttpStatusMessage.fromString(e.getLocalizedMessage()).send(response);

        }

        if(doCount){

            mv.addObject(count);

        } else {

            mv.addObject(allElements);

        }

        return mv;

    }

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

//	public ModelAndView doGetSpecimens(

//			@PathVariable("uuid") UUID uuid,

//			HttpServletRequest request,

//			HttpServletResponse response) throws IOException, ClassNotFoundException {

//		logger.info("doGetSpecimens() - " + request.getServletPath());

//

//		ModelAndView mv = new ModelAndView();

//

//		List<DerivedUnitFacade> derivedUnitFacadeList = new ArrayList<DerivedUnitFacade>();

//

//		// find speciemens in the TaxonDescriptions

//		List<TaxonDescription> taxonDescriptions = doGetDescriptions(uuid, request, response);

//		if (taxonDescriptions != null) {

//

//			for (TaxonDescription description : taxonDescriptions) {

//				derivedUnitFacadeList.addAll( occurrenceService.listDerivedUnitFacades(description, null) );

//			}

//		}

//		// TODO find speciemens in the NameDescriptions ??

//

//		// TODO also find type specimens

//

//		mv.addObject(derivedUnitFacadeList);

//

//		return mv;

//	}

    /**

     * Get the {@link Media} attached to the {@link Taxon} instance

     * identified by the <code>{taxon-uuid}</code>.

     *

     * Usage /{datasource-name}/portal/taxon/{taxon-

     * uuid}/media/{mime type

     * list}/{size}[,[widthOrDuration}][,{height}]/

     *

     * Whereas

     * <ul>

     * <li><b>{mime type list}</b>: a comma separated list of mime types, in the

     * order of preference. The forward slashes contained in the mime types must

     * be replaced by a colon. Regular expressions can be used. Each media

     * associated with this given taxon is being searched whereas the first

     * matching mime type matching a representation always rules.</li>

     * <li><b>{size},{widthOrDuration},{height}</b>: <i>not jet implemented</i>

     * valid values are an integer or the asterisk '*' as a wildcard</li>

     * </ul>

     *

     * @param request

     * @param response

     * @return a List of {@link Media} entities which are initialized

     *         using the following initialization strategy:

     *         {@link #TAXONDESCRIPTION_INIT_STRATEGY}

     * @throws IOException

     */

    @RequestMapping(

        value = {"media"},

        method = RequestMethod.GET)

    public List<Media> doGetMedia(

            @PathVariable("uuid") UUID uuid,

            @RequestParam(value = "type", required = false) Class<? extends MediaRepresentationPart> type,

            @RequestParam(value = "mimeTypes", required = false) String[] mimeTypes,

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

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

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

            HttpServletRequest request, HttpServletResponse response) throws IOException {

        logger.info("doGetMedia()" + request.getServletPath());

        Taxon t = getCdmBaseInstance(Taxon.class, uuid, response, (List<String>)null);

        String path = request.getServletPath();

        List<Media> returnMedia = getMediaForTaxon(t, type, mimeTypes, widthOrDuration, height, size);

        return returnMedia;

    }

    @RequestMapping(

            value = {"subtree/media"},

            method = RequestMethod.GET)

        public List<Media> doGetSubtreeMedia(

                @PathVariable("uuid") UUID uuid,

                @RequestParam(value = "type", required = false) Class<? extends MediaRepresentationPart> type,

                @RequestParam(value = "mimeTypes", required = false) String[] mimeTypes,

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

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

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

                HttpServletRequest request, HttpServletResponse response)throws IOException {

        logger.info("doGetMedia()" + request.getServletPath());

        Taxon taxon = getCdmBaseInstance(Taxon.class, uuid, response, TAXON_WITH_NODES_INIT_STRATEGY);

        String requestPath = request.getServletPath();

        List<Media> returnMedia = getMediaForTaxon(taxon, type, mimeTypes, widthOrDuration, height, size);

        TaxonNode node;

        //looking for all medias of genus

        if (taxon.getTaxonNodes().size()>0){

            Set<TaxonNode> nodes = taxon.getTaxonNodes();

            Iterator<TaxonNode> iterator = nodes.iterator();

            //TaxonNode holen

            node = iterator.next();

            //Check if TaxonNode belongs to the current tree

            node = classificationService.loadTaxonNode(node, TAXONNODE_WITHTAXON_INIT_STRATEGY);

            Set<TaxonNode> children = node.getChildNodes();

            Taxon childTaxon;

            for (TaxonNode child : children){

                childTaxon = child.getTaxon();

                childTaxon = (Taxon)taxonService.load(childTaxon.getUuid(), null);

                returnMedia.addAll(getMediaForTaxon(childTaxon, type, mimeTypes, widthOrDuration, height, size));

            }

        }

        return returnMedia;

    }

    private List<Media> getMediaForTaxon(Taxon taxon, Class<? extends MediaRepresentationPart> type, String[] mimeTypes,

            Integer widthOrDuration, Integer height, Integer size){

        Pager<TaxonDescription> p =

            descriptionService.getTaxonDescriptions(taxon, null, null, null, null, TAXONDESCRIPTION_MEDIA_INIT_STRATEGY);

        // pars the media and quality parameters

        // collect all media of the given taxon

        boolean limitToGalleries = false;

        List<Media> taxonMedia = new ArrayList<Media>();

        for(TaxonDescription desc : p.getRecords()){

            if(!limitToGalleries || desc.isImageGallery()){

                for(DescriptionElementBase element : desc.getElements()){

                    for(Media media : element.getMedia()){

                        taxonMedia.add(media);

                    }

                }

            }

        }

        List<Media> returnMedia = MediaUtils.findPreferredMedia(taxonMedia, type,

                mimeTypes, null, widthOrDuration, height, size);

        return returnMedia;

    }

// ---------------------- code snippet preserved for possible later use --------------------

//	@RequestMapping(

//			value = {"/*/portal/taxon/*/descriptions"},

//			method = RequestMethod.GET)

//	public List<TaxonDescription> doGetDescriptionsbyFeatureTree(HttpServletRequest request, HttpServletResponse response)throws IOException {

//		TaxonBase tb = getCdmBase(request, response, null, Taxon.class);

//		if(tb instanceof Taxon){

//			//T O D O this is a quick and dirty implementation -> generalize

//			UUID featureTreeUuid = readValueUuid(request, featureTreeUuidPattern);

//

//			FeatureTree featureTree = descriptionService.getFeatureTreeByUuid(featureTreeUuid);

//			Pager<TaxonDescription> p = descriptionService.getTaxonDescriptions((Taxon)tb, null, null, null, null, TAXONDESCRIPTION_INIT_STRATEGY);

//			List<TaxonDescription> descriptions = p.getRecords();

//

//			if(!featureTree.isDescriptionSeparated()){

//

//				TaxonDescription superDescription = TaxonDescription.NewInstance();

//				//put all descriptionElements in superDescription and make it invisible

//				for(TaxonDescription description: descriptions){

//					for(DescriptionElementBase element: description.getElements()){

//						superDescription.addElement(element);

//					}

//				}

//				List<TaxonDescription> separatedDescriptions = new ArrayList<TaxonDescription>(descriptions.size());

//				separatedDescriptions.add(superDescription);

//				return separatedDescriptions;

//			}else{

//				return descriptions;

//			}

//		} else {

//			response.sendError(HttpServletResponse.SC_NOT_FOUND, "invalid type; Taxon expected but " + tb.getClass().getSimpleName() + " found.");

//			return null;

//		}

//	}

}