/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.ui.actions;

import java.util.Arrays;

import org.teiid.designer.ui.UiConstants;
import org.teiid.designer.ui.common.actions.GlobalActionsMap;


/**
 * The <code>ModelerGlobalActionsMap</code> class contains an entry for each of the global actions.
 * Initially each action is set to their default actions. Keys for the map is the global key of the
 * action. These can be found in {@link IModelerActionConstants}. The value can be one of the following:
 * <ul>
 * <li>an IAction object responsible for overriding the default action, 
 * <li>a value indicating the default action should be used (constant provided), and
 * <li>an IAction that will never be enabled indicating the action is not supported (constant provided).
 * </ul>
 * <p>
 * Sometimes an action is unsupported. An action which is never enabled will be used as the value
 * for that global action key.
 *
 * @since 8.0
 */
public class ModelerGlobalActionsMap extends GlobalActionsMap
                                     implements IModelerActionConstants,
                                                UiConstants {
    
    ///////////////////////////////////////////////////////////////////////////////////////////////
    // FIELDS
    ///////////////////////////////////////////////////////////////////////////////////////////////

    /** All global actions of the modeler. Includes Eclipse global actions. */
    public static final String[] ALL_GLOBAL_ACTIONS;
    
    ///////////////////////////////////////////////////////////////////////////////////////////////
    // INITIALIZER
    ///////////////////////////////////////////////////////////////////////////////////////////////
    
    static {
        ALL_GLOBAL_ACTIONS = new String[ModelerGlobalActions.ALL_ACTIONS.length + EclipseGlobalActions.ALL_ACTIONS.length];
        System.arraycopy(ModelerGlobalActions.ALL_ACTIONS, 
                         0,
                         ALL_GLOBAL_ACTIONS, 
                         0, 
                         ModelerGlobalActions.ALL_ACTIONS.length);
        System.arraycopy(EclipseGlobalActions.ALL_ACTIONS, 
                         0,
                         ALL_GLOBAL_ACTIONS, 
                         ModelerGlobalActions.ALL_ACTIONS.length, 
                         EclipseGlobalActions.ALL_ACTIONS.length);
    }
    
    ///////////////////////////////////////////////////////////////////////////////////////////////
    // METHODS
    ///////////////////////////////////////////////////////////////////////////////////////////////

    /**
     * Indicates if the given key represents a Modeler global action. This does not include Eclipse global
     * actions.
     * @param theKey the key being checked
     * @return <code>true</code> if a Modeler global action; <code>false</code> otherwise.
     */
    public static boolean isModelerGlobalAction(String theKey) {
        return Arrays.asList(ModelerGlobalActions.ALL_ACTIONS).contains(theKey);
    }
    
    /**
     * Indicates if the key is valid.
     * @param theKey the proposed key
     * @return <code>true</code> if key is valid; <code>false</code> otherwise.
     */
    @Override
    public boolean isValidKey(Object theKey) {
        boolean result = super.isValidKey(theKey);
        
        if (!result) {
            for (int i = 0; i < ModelerGlobalActions.ALL_ACTIONS.length; i++) {
                if (theKey.equals(ModelerGlobalActions.ALL_ACTIONS[i])) {
                    result = true;
                    break;
                }
            }
        }
        
        return result;
    }
    
    /* (non-Javadoc)
     * see org.teiid.designer.ui.common.actions.ModelerGlobalActionsMap#reset()
     */
    @Override
    public void reset() {
        super.reset();

        for (int i = 0; i < ModelerGlobalActions.ALL_ACTIONS.length; ++i ) {
            put(ModelerGlobalActions.ALL_ACTIONS[i], DEFAULT_ACTION);            
        }

    }

}