EDIT

// $Id$

/**

* Copyright (C) 2013 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.taxeditor.editor.view.derivate;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import org.eclipse.jface.resource.ImageDescriptor;

import org.eclipse.ui.IEditorInput;

import org.eclipse.ui.IPersistableElement;

import eu.etaxonomy.cdm.api.application.CdmApplicationState;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

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

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

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

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

import eu.etaxonomy.taxeditor.editor.CdmEntitySessionInput;

import eu.etaxonomy.taxeditor.editor.EditorUtil;

import eu.etaxonomy.taxeditor.editor.Messages;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.view.derivateSearch.DerivateLabelProvider;

/**

 * Editor input for the {@link DerivateView} which holds the currently selected derivate for which

 * the derivate hierarchy should be shown in the DerivateView.<br>

 * It also holds a {@link SpecimenOrObservationBase} which is the root of the hierarchy. (both may be the same object)

 * @author pplitzner

 * @date 25.11.2013

 *

 */

public class DerivateViewEditorInput extends CdmEntitySessionInput implements IEditorInput {

    /**

     * The selected derivate {@link UUID}s

     */

    private final Set<SpecimenOrObservationBase<?>> derivateEntities;

    /**

     * List of the {@link UUID}s of the root elements of the hierarchy (may be the same objects as the derivates)

     */

    private Set<SpecimenOrObservationBase<?>> rootEntities;

    private Set<UUID> rootUUIDs;

    private final ConversationHolder conversationHolder;

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

            "descriptions",

            "annotations",

            "markers",

            "credits",

            "extensions",

            "rights",

            "sources",

            "derivationEvents.derivatives.annotations",

            "derivationEvents.derivatives.markers",

            "derivationEvents.derivatives.credits",

            "derivationEvents.derivatives.extensions",

            "derivationEvents.derivatives.rights",

            "derivationEvents.derivatives.sources"

    });

    /**

     * Creates an editor input for the {@link DerivateView} with the currently selected derivates and the

     * corresponding {@link FieldUnit}s (both may be the same object).

     * @param derivateUuids the {@link UUID}s of the derivates for which the derivate hierarchy should be shown

     * @param rootUUIDs the root of the hierarchy

     */

    public DerivateViewEditorInput(Set<UUID> derivateUuids) {

        super(false);

        rootUUIDs = derivateUuids;

        //FIXME:Remoting temporary hack for making the sessions work

        //This should ideally be changed to initializing the

        //super class with a collection of (id) objects which can

        //then be used for the hashCode, equals methods

        initSession();

        this.conversationHolder = CdmStore.createConversation();

        this.derivateEntities = new HashSet<SpecimenOrObservationBase<?>>();

        this.rootEntities = new HashSet<SpecimenOrObservationBase<?>>();

        for (UUID uuid : derivateUuids) {

            SpecimenOrObservationBase<?> derivate = CdmStore.getService(IOccurrenceService.class).load(uuid, SPECIMEN_INIT_STRATEGY);

            derivateEntities.add(derivate);

            if(derivate instanceof FieldUnit){

                rootEntities.add(derivate);

            }

            else if(derivate instanceof DerivedUnit){

                SpecimenOrObservationBase<?> topMostDerivate = EditorUtil.getTopMostDerivate(derivate);

                if(topMostDerivate!=null){

                    rootEntities.add(topMostDerivate);

                }

            }

        }

        if(rootEntities.isEmpty()){

            rootEntities = derivateEntities;

        }

        if(rootEntities.isEmpty()){

            MessagingUtils.messageDialog(Messages.DerivateViewEditorInput_FAIL_INIT, DerivateViewEditorInput.class, Messages.DerivateViewEditorInput_NO_ROOT);

        }

    }

    /* (non-Javadoc)

     * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)

     */

    @Override

    public Object getAdapter(Class adapter) {

        // TODO Auto-generated method stub

        return null;

    }

    /* (non-Javadoc)

     * @see org.eclipse.ui.IEditorInput#exists()

     */

    @Override

    public boolean exists() {

        return false;

    }

    /* (non-Javadoc)

     * @see org.eclipse.ui.IEditorInput#getImageDescriptor()

     */

    @Override

    public ImageDescriptor getImageDescriptor() {

        // TODO Auto-generated method stub

        return null;

    }

    /* (non-Javadoc)

     * @see org.eclipse.ui.IEditorInput#getName()

     */

    @Override

    public String getName() {

        return getEditorName();

    }

    /* (non-Javadoc)

     * @see org.eclipse.ui.IEditorInput#getPersistable()

     */

    @Override

    public IPersistableElement getPersistable() {

        return null;

    }

    /* (non-Javadoc)

     * @see org.eclipse.ui.IEditorInput#getToolTipText()

     */

    @Override

    public String getToolTipText() {

        return getEditorName();

    }

    private String getEditorName() {

        String name = null;

        for( SpecimenOrObservationBase<?> specimen : rootEntities){

            if(specimen!=null){

                if(name==null){

                    name = DerivateLabelProvider.getDerivateText(specimen, conversationHolder);

                }

                else{

                    name += " + "+DerivateLabelProvider.getDerivateText(specimen, conversationHolder); //$NON-NLS-1$

                }

            }

        }

        return name;

    }

    @Override

    public Set<SpecimenOrObservationBase<?>> getRootEntities() {

        return rootEntities;

    }

    public Set<SpecimenOrObservationBase<?>> getDerivateEntities() {

        return derivateEntities;

    }

    public void addRootEntity(SpecimenOrObservationBase<?> root){

        rootEntities.add(root);

    }

    public ConversationHolder getConversationHolder() {

        return conversationHolder;

    }

    /* (non-Javadoc)

     * @see java.lang.Object#hashCode()

     */

    @Override

    public int hashCode() {

        final int prime = 31;

        int result = 1;

        result = prime * result + ((rootUUIDs == null) ? 0 : rootUUIDs.hashCode());

        return result;

    }

    /* (non-Javadoc)

     * @see java.lang.Object#equals(java.lang.Object)

     */

    @Override

    public boolean equals(Object obj) {

        if (this == obj) {

            return true;

        }

        if (obj == null) {

            return false;

        }

        if (getClass() != obj.getClass()) {

            return false;

        }

        DerivateViewEditorInput other = (DerivateViewEditorInput) obj;

        if (rootUUIDs == null) {

            if (other.rootUUIDs != null) {

                return false;

            }

        } else if (!rootUUIDs.equals(other.rootUUIDs)) {

            return false;

        }

        return true;

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.taxeditor.editor.CdmEntitySessionInput#merge()

     */

    @Override

    public void merge() {

       List<SpecimenOrObservationBase> mergedEntities = CdmApplicationState.getCurrentAppConfig().getOccurrenceService().merge(new ArrayList(getRootEntities()));

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getPropertyPathsMap()

     */

    @Override

    public Map<Object, List<String>> getPropertyPathsMap() {

        List<String> specimenPropertyPaths = Arrays.asList(new String[] {

                "descriptions",

                "derivationEvents.derivates",

                "annotations",

                "markers",

                "credits",

                "extensions",

                "rights",

                "sources"

        });

        Map<Object, List<String>> specimenPropertyPathMap =

                new HashMap<Object, List<String>>();

        specimenPropertyPathMap.put(SpecimenOrObservationBase.class,specimenPropertyPaths);

        return specimenPropertyPathMap;

    }

}