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.taxeditor.ui.dialog.selection;

import java.util.ArrayList;

import java.util.List;

import java.util.UUID;

import org.apache.commons.lang.StringUtils;

import org.eclipse.jface.action.Action;

import org.eclipse.jface.action.IAction;

import org.eclipse.jface.dialogs.Dialog;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Shell;

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

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

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

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

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

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

import eu.etaxonomy.cdm.model.metadata.CdmPreference;

import eu.etaxonomy.cdm.model.metadata.PreferencePredicate;

import eu.etaxonomy.taxeditor.model.ImageResources;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

import eu.etaxonomy.taxeditor.newWizard.AbstractNewEntityWizard;

import eu.etaxonomy.taxeditor.preference.CdmPreferenceCache;

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

import eu.etaxonomy.taxeditor.store.CdmStore;

/**

 * @author n.hoffmann

 * @created May 11, 2010

 * @version 1.0

 */

public class NamedAreaSelectionDialog extends

		AbstractFilteredCdmResourceSelectionDialog<NamedArea> {

	private class IncludeNamedAreaVocabulary extends Action {

		private final TermVocabulary<NamedArea> vocabulary;

		/**

		 * Creates a new instance of the class.

		 */

		public IncludeNamedAreaVocabulary(TermVocabulary<NamedArea> vocabulary) {

			super(vocabulary.getTitleCache(), IAction.AS_CHECK_BOX);

			this.vocabulary = vocabulary;

		}

		@Override

        public void run(){

			if(isChecked()){

				selectedVocabularies.add(vocabulary);

			}else{

				selectedVocabularies.remove(vocabulary);

			}

			PreferencesUtil.setBooleanValue(getPrefKey(vocabulary), !isChecked());

			search();

		}

	}

	protected List<TermVocabulary> selectedVocabularies;

    protected List<TermVocabulary> vocabularies;

	/**

	 * Creates a filtered selection dialog to select a named area.

	 *

	 * @param shell

	 * 				The shell for displaying this widget

	 * @param namedArea

	 * 				A namedArea that should be selected when the dialog opens

	 * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.

	 * @param preferenceId a class which is used for generating the preference key so that every

	 * dialogs can be grouped to have their own preferences depending on this id

	 * @param preselectedVocabularyUuids the {@link UUID}s of the pre-selected vocabularies

	 * @return a {@link eu.etaxonomy.cdm.model.location.NamedArea} object.

	 */

	public static NamedArea select(Shell shell, //ConversationHolder conversation,

	        NamedArea namedArea, String preferenceId, UUID... preselectedVocabularyUuids) {

		NamedAreaSelectionDialog dialog = new NamedAreaSelectionDialog(shell, //conversation,

				"Choose an area", false, namedArea, preferenceId, preselectedVocabularyUuids);

		return getSelectionFromDialog(dialog);

	}

	protected NamedAreaSelectionDialog(Shell shell, //ConversationHolder conversation,

	        String title, boolean multi, NamedArea namedArea, Object preferenceId, UUID... preselectedVocabularyUuids) {

		super(shell, //conversation,

		        title, multi, NamedAreaSelectionDialog.class.getCanonicalName(), namedArea);

		selectedVocabularies = new ArrayList<TermVocabulary>();

		this.preferenceID = preferenceId;

		if (preselectedVocabularyUuids == null || preselectedVocabularyUuids.length == 0){

		    preselectedVocabularyUuids = createVocabularyUuidList();

		}

		if (preselectedVocabularyUuids != null){

    		for(int i=0;i<preselectedVocabularyUuids.length;i++){

    			TermVocabulary preselectedVocabulary = CdmStore.getService(IVocabularyService.class).find(preselectedVocabularyUuids[i]);

    			selectedVocabularies.add(preselectedVocabulary);

    		}

		}

		selectedVocabularies = createSelectedVocabularies();

	}

    protected List<TermVocabulary> createSelectedVocabularies() {

        List<TermVocabulary> tempSelectedVocabularies = new ArrayList<TermVocabulary>();

        for(TermVocabulary vocabulary:vocabularies){

			if((selectedVocabularies.contains(vocabulary) && !PreferencesUtil.getBooleanValue(getPrefKey(vocabulary)))

					|| !PreferencesUtil.getBooleanValue(getPrefKey(vocabulary))){

				tempSelectedVocabularies.add(vocabulary);

			}

		}

        return tempSelectedVocabularies;

    }

    private static UUID[] createVocabularyUuidList() {

        String preselectedVocString = PreferencesUtil.getStringValue(PreferencePredicate.AvailableDistributionAreaVocabularies.getKey());

        if (StringUtils.isBlank(preselectedVocString)){

            return null;

        }

        String[] preselectedVocArray = preselectedVocString.split(";");

        UUID[] uuidList = new UUID[preselectedVocArray.length];

        int i = 0;

        for (String uuidString: preselectedVocArray){

            uuidList[i]= UUID.fromString(uuidString);

            i++;

        }

        return uuidList;

    }

	private String getPrefKey(TermVocabulary vocabulary){

		return "hide_"+NamedAreaSelectionDialog.class.getCanonicalName()+vocabulary.getUuid()+preferenceID;

	}

	/** {@inheritDoc} */

	@Override

	protected NamedArea getPersistentObject(UUID uuid) {

	    DefinedTermBase area =  CdmStore.getService(ITermService.class).find(uuid);

	    if (area instanceof NamedArea){

	        return (NamedArea) area;

	    }

		return null;

	}

	/** {@inheritDoc} */

	@Override

	protected void init() {

		vocabularies = getAvailableVocabularies();

	}

	private List<TermVocabulary> getAvailableVocabularies(){

	    vocabularies = new ArrayList();

	    CdmPreferenceCache cache = CdmPreferenceCache.instance();

        CdmPreference pref = cache.get(PreferencePredicate.AvailableDistributionAreaVocabularies.getKey());

	    if (pref != null && !pref.isAllowOverride()){

            UUID[] preselectedVocabularyUuids = createVocabularyUuidList();

            for(int i=0;i<preselectedVocabularyUuids.length;i++){

                TermVocabulary preselectedVocabulary = CdmStore.getService(IVocabularyService.class).find(preselectedVocabularyUuids[i]);

                vocabularies.add(preselectedVocabulary);

            }

        }else{

            vocabularies = CdmStore.getService(IVocabularyService.class).listByTermType(TermType.NamedArea, true, null, null, null, null);

        }

		//List<TermVocabulary> vocabularies = CdmStore.getService(IVocabularyService.class).listByTermType(TermType.NamedArea, true, null, null, null, null);

		return vocabularies;

	}

//	/** {@inheritDoc} */

//	@Override

//	protected void search() {

//	    Control control =getSearchField();

//        String pattern = null;

//        if (control != null){

//            pattern = ((Text)control).getText();

//        }

//

//        if (pattern == null || pattern.equals("?")){

//            model = CdmStore.getService(ITermService.class).getUuidAndTitleCache(selectedVocabularies, limitOfInitialElements, null, PreferencesUtil.getGlobalLanguage());

//        }else{

//            model = CdmStore.getService(ITermService.class).getUuidAndTitleCache(selectedVocabularies, limitOfInitialElements, pattern, PreferencesUtil.getGlobalLanguage());

//        }

//	}

//	/** {@inheritDoc} */

//	@Override

//	protected Control createExtendedContentArea(Composite parent) {

//		return null;

//	}

	/** {@inheritDoc} */

	@Override

	protected String getTitle(NamedArea namedArea) {

		try {

			String result = NamedArea.labelWithLevel(namedArea, CdmStore.getDefaultLanguage());

			return result;

		} catch (Exception e) {

			MessagingUtils.error(NamedAreaSelectionDialog.class, "Error occurred when trying retrieve title for Named Area: " + namedArea.getUuid(), e);

			return namedArea.getTitleCache();

		}

	}

	/** {@inheritDoc} */

	@Override

	protected AbstractNewEntityWizard getNewEntityWizard(String parameter) {

		return null;

	}

	/** {@inheritDoc} */

	@Override

	protected String[] getNewWizardText() {

		return null;

	}

	@Override

    void createFilterButton(Composite searchAndFilter)

	    {

            filterButton = new Button(searchAndFilter, SWT.NONE);

//            filterButton.setText("Filter");

            filterButton.setImage(ImageResources.getImage(ImageResources.FUNNEL_ICON));

//            SelectionListener filterSelectionListener = new FilterSelectionListener(preferenceID, this);

            filterButton.addSelectionListener(new SelectionListener(){

                @Override

                public void widgetSelected(SelectionEvent e) {

                        Object source = e.getSource();

                        String text = null;

                        if (source instanceof Button){

                            Shell shell = ((Button)source).getShell();

                            Dialog dialog = new FilterDialog(getShell(), preferenceID, selectedVocabularies, vocabularies);

                            if(dialog!=null){

                                dialog.open();

                            }

                            createSelectedVocabularies();

                            search();

                        }

                }

                @Override

                public void widgetDefaultSelected(SelectionEvent e) {

                    // TODO Auto-generated method stub

                }

            });

        }

    /* (non-Javadoc)

     * @see eu.etaxonomy.taxeditor.ui.dialog.selection.AbstractFilteredCdmResourceSelectionDialog#callService(java.lang.String)

     */

    @Override

    void callService(String pattern) {

        if (selectedVocabularies == null || selectedVocabularies.size() == 0){

            model = CdmStore.getService(ITermService.class).getUuidAndTitleCache(vocabularies, limitOfInitialElements, pattern, PreferencesUtil.getGlobalLanguage());

        }else{

            model = CdmStore.getService(ITermService.class).getUuidAndTitleCache(selectedVocabularies, limitOfInitialElements, pattern, PreferencesUtil.getGlobalLanguage());

        }

    }

}