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.taxeditor.editor.definedterm;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.Comparator;

import java.util.EnumSet;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Set;

import org.eclipse.jface.action.IContributionItem;

import org.eclipse.jface.action.MenuManager;

import org.eclipse.jface.action.Separator;

import org.eclipse.swt.SWT;

import org.eclipse.ui.PlatformUI;

import org.eclipse.ui.actions.CompoundContributionItem;

import org.eclipse.ui.menus.CommandContributionItem;

import org.eclipse.ui.menus.CommandContributionItemParameter;

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

import eu.etaxonomy.taxeditor.l10n.Messages;

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

import eu.etaxonomy.taxeditor.store.CdmStore;

/**

 * Menu used in the store plugin xml to dynamically generate menu (sub-menu) contribution items

 * for term types which when clicked open the defined term editor for the chosen term type

 *

 * @author pplitzner

 * @date 21 Jul 2015

 *

 */

public class DefinedTermMenu extends CompoundContributionItem {

    @Override

    protected IContributionItem[] getContributionItems() {

        Collection<IContributionItem> items = new ArrayList<IContributionItem>();

        if(CdmStore.isActive()){

            MenuManager dtMenuManager =

                    new MenuManager(Messages.DefinedTermMenu_TERM_EDITOR,"eu.etaxonomy.taxeditor.store.definedTermEditorMenu"); //$NON-NLS-2$

            dtMenuManager.setVisible(true);

            items.add(dtMenuManager);

            //add Feature and NamedArea to top level

            dtMenuManager.add(addChildTermsToMenuManager(TermType.Feature));

            dtMenuManager.add(addChildTermsToMenuManager(TermType.NamedArea));

            dtMenuManager.add(new Separator());

            MenuManager otherMenuManager =

                    new MenuManager(Messages.DefinedTermMenu_OTHERS,"eu.etaxonomy.taxeditor.store.term.other.menu"); //$NON-NLS-2$

            otherMenuManager.setVisible(true);

            dtMenuManager.add(otherMenuManager);

            //FIXME E4: This should be removed during e4 migration. dynamic menu should be declared in model fragment

            dtMenuManager.add(new Separator());

            dtMenuManager.add(createFeatureTreeMenuItem());

            List<TermType> ttList = new ArrayList<TermType>(EnumSet.allOf(TermType.class));

            Collections.sort(ttList,new SortByTermTypeMessage());

            for (TermType tt : ttList)

            {

                //skip Feature and NamedArea as they have already been added to top level

                if(tt.equals(TermType.Feature) || tt.equals(TermType.NamedArea)){

                    continue;

                }

                // if term type has a parent, do not add it

                // it will be added in the recursive call

                if(tt.getKindOf() == null) {

                    IContributionItem ici = addChildTermsToMenuManager(tt);

                    if(ici != null) {

                        otherMenuManager.add(ici);

                    }

                }

            }

        }

	    return items.toArray(new IContributionItem[]{});

	}

	private IContributionItem addChildTermsToMenuManager(TermType termType) {

		//FIXME : need a better way to find out if a term type can be editable (ticket 3853)

		if(termType.getEmptyDefinedTermBase() != null) {

			Set<TermType> children = termType.getGeneralizationOf();

			// term type has no children, so create menu item

			if(children.isEmpty()) {

				return createMenuItem(termType);

			}

			// term type has children, so create sub menu

			MenuManager dtMenuManager =

					new MenuManager(termType.getMessage(PreferencesUtil.getGlobalLanguage()),"eu.etaxonomy.taxeditor.store." + termType.getKey() + Messages.DefinedTermMenu_MENU); //$NON-NLS-1$

			dtMenuManager.setVisible(true);

			dtMenuManager.add(createDefaultMenuItem(termType));

			Separator sep = new Separator();

			dtMenuManager.add(sep);

			// add child items to the sub menu

			for(TermType tt : children) {

				IContributionItem item = addChildTermsToMenuManager(tt);

				if(item != null) {

					dtMenuManager.add(item);

				}

			}

			return dtMenuManager;

		} else {

			return null;

		}

	}

	private CommandContributionItem createMenuItem(TermType termType) {

		Map<String, String> params = new HashMap<String, String>();

		params.put("eu.etaxonomy.taxeditor.store.openDefinedTermEditor.termTypeUuid", //$NON-NLS-1$

				termType.getUuid().toString());

        CommandContributionItemParameter p = new CommandContributionItemParameter(

                PlatformUI.getWorkbench(),

                "", //$NON-NLS-1$

                "eu.etaxonomy.taxeditor.store.openDefinedTermEditor", //$NON-NLS-1$

                params,

                null,

                null,

                null,

                termType.getMessage(),

                "", //$NON-NLS-1$

                "", //$NON-NLS-1$

                SWT.PUSH,

                "", //$NON-NLS-1$

                true);

        CommandContributionItem item = new CommandContributionItem(p);

        return item;

	}

	private CommandContributionItem createFeatureTreeMenuItem() {

		Map<String, String> params = new HashMap<String, String>();

		params.put("eu.etaxonomy.taxeditor.workbench.commandparameter.partName", //$NON-NLS-1$

				"eu.etaxonomy.taxeditor.featuretree.e4.FeatureTreeEditor"); //$NON-NLS-1$

        CommandContributionItemParameter p = new CommandContributionItemParameter(

                PlatformUI.getWorkbench(),

                "eu.etaxonomy.taxeditor.featuretree.commandContributionItemParameter", //$NON-NLS-1$

                "eu.etaxonomy.taxeditor.command.openPart", //$NON-NLS-1$

                params,

                null,

                null,

                null,

                Messages.DefinedTermMenu_FEATURE_TREE,

                "", //$NON-NLS-1$

                "", //$NON-NLS-1$

                SWT.PUSH,

                "", //$NON-NLS-1$

                true);

        CommandContributionItem item = new CommandContributionItem(p);

        return item;

	}

	private CommandContributionItem createDefaultMenuItem(TermType termType) {

	    Map<String, String> params = new HashMap<String, String>();

	    params.put("eu.etaxonomy.taxeditor.store.openDefinedTermEditor.termTypeUuid", //$NON-NLS-1$

	            termType.getUuid().toString());

	    CommandContributionItemParameter p = new CommandContributionItemParameter(

	            PlatformUI.getWorkbench(),

	            "", //$NON-NLS-1$

	            "eu.etaxonomy.taxeditor.store.openDefinedTermEditor", //$NON-NLS-1$

	            params,

	            null,

	            null,

	            null,

	            String.format(Messages.DefinedTermMenu_OTHER_S, termType.getMessage()),

	            "", //$NON-NLS-1$

	            "", //$NON-NLS-1$

	            SWT.PUSH,

	            "", //$NON-NLS-1$

	            true);

	    CommandContributionItem item = new CommandContributionItem(p);

	    return item;

	}

	private class SortByTermTypeMessage implements Comparator<TermType> {

	    @Override

        public int compare(TermType t1, TermType t2) {

	        if (t1.equals(t2)){

	            return 0;

	        }

	        int result = t1.getMessage().compareTo(t2.getMessage());

	        if (result == 0){

	            return t1.compareTo(t2);

	        }

	        return result;

	    }

	}

}