/*****************************************************************************
 * Copyright (c) 2012 CEA LIST.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *		
 *		CEA LIST - Initial API and implementation
 *
 *****************************************************************************/
package org.eclipse.papyrus.uml.service.types.utils;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest;
import org.eclipse.gmf.runtime.notation.Edge;
import org.eclipse.gmf.runtime.notation.View;

/**
 * Utility class for request parameters.
 */
public class RequestParameterUtils {

	/**
	 * Get the source graphical view provided as {@link IEditCommandRequest} parameter.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the source view
	 */
	public static View getSourceView(IEditCommandRequest req) {
		return (View)req.getParameter(RequestParameterConstants.EDGE_CREATE_REQUEST_SOURCE_VIEW);
	}

	/**
	 * Get the target graphical view provided as {@link IEditCommandRequest} parameter.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the target view
	 */
	public static View getTargetView(IEditCommandRequest req) {
		return (View)req.getParameter(RequestParameterConstants.EDGE_CREATE_REQUEST_TARGET_VIEW);
	}

	/**
	 * Get the reconnected graphical edge provided as {@link IEditCommandRequest} parameter.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the reconnected edge
	 */
	public static Edge getReconnectedEdge(IEditCommandRequest req) {
		return (Edge)req.getParameter(RequestParameterConstants.GRAPHICAL_RECONNECTED_EDGE);
	}

	/**
	 * Get the reconnected graphical end view provided as {@link IEditCommandRequest} parameter.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the reconnected end view
	 */
	public static View getReconnectedEndView(IEditCommandRequest req) {
		return (View)req.getParameter(RequestParameterConstants.EDGE_REORIENT_REQUEST_END_VIEW);
	}

	/**
	 * Get the list of dependents that should not be destroyed during delete.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the list of dependents to keep
	 */
	public static List<EObject> getDependentsToKeep(IEditCommandRequest req) {
		return (List<EObject>)req.getParameter(RequestParameterConstants.DEPENDENTS_TO_KEEP);
	}

	/**
	 * Get the list of association related elements currently re-factored.
	 * 
	 * @param req
	 *        the edit command request
	 * 
	 * @return the list of association related elements currently re-factored
	 */
	public static List<EObject> getAssociationRefactoredElements(IEditCommandRequest req) {
		return (List<EObject>)req.getParameter(RequestParameterConstants.ASSOCIATION_REFACTORED_ELEMENTS);
	}

	/**
	 * Add an EObject to the list of association related elements currently re-factored.
	 *
	 * @param eObject the eObject to add
	 */
	public static void addAssociationRefactoredElement(IEditCommandRequest req, EObject eObject) {
		List<EObject> refactoredElements = (getAssociationRefactoredElements(req) != null) ? getAssociationRefactoredElements(req) : new ArrayList<EObject>();
		refactoredElements.add(eObject);
		req.getParameters().put(RequestParameterConstants.ASSOCIATION_REFACTORED_ELEMENTS, refactoredElements);
	}
}