/*****************************************************************************
* Copyright (c) 2009 Atos Origin.
*
*
* 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:
* Atos Origin - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.activity.parser.custom;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EAttribute;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.emf.transaction.util.TransactionUtil;
import org.eclipse.gmf.runtime.common.core.command.ICommand;
import org.eclipse.gmf.runtime.common.core.command.UnexecutableCommand;
import org.eclipse.gmf.runtime.diagram.ui.commands.CommandProxy;
import org.eclipse.gmf.runtime.emf.commands.core.command.CompositeTransactionalCommand;
import org.eclipse.gmf.runtime.emf.ui.services.parser.ISemanticParser;
import org.eclipse.papyrus.uml.diagram.activity.parsers.MessageFormatParser;
import org.eclipse.papyrus.uml.diagram.common.commands.SetValueSpecificationValueCommand;
import org.eclipse.papyrus.uml.tools.utils.ValueSpecificationUtil;
import org.eclipse.uml2.uml.Action;
import org.eclipse.uml2.uml.ActionInputPin;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.Pin;
import org.eclipse.uml2.uml.ReadSelfAction;
import org.eclipse.uml2.uml.ReadVariableAction;
import org.eclipse.uml2.uml.UMLPackage;
import org.eclipse.uml2.uml.ValuePin;
import org.eclipse.uml2.uml.ValueSpecification;
import org.eclipse.uml2.uml.ValueSpecificationAction;
import org.eclipse.uml2.uml.Variable;
/**
* A specific parser for displaying the label of a Pin. This parser refreshes
* the text displayed for the Pin.
*/
public class PinValueParser extends MessageFormatParser implements ISemanticParser {
/** The keyword for indication a ReadSelfAction input pin */
private static final String SELF_KEYWORD = "self";
public PinValueParser(EAttribute[] features, EAttribute[] editableFeatures) {
super(features, editableFeatures);
}
public PinValueParser(EAttribute[] features) {
super(features);
}
public PinValueParser() {
super(new EAttribute[]{ UMLPackage.eINSTANCE.getNamedElement_Name() });
}
protected EStructuralFeature getEStructuralFeature(Object notification) {
EStructuralFeature featureImpl = null;
if(notification instanceof Notification) {
Object feature = ((Notification)notification).getFeature();
if(feature instanceof EStructuralFeature) {
featureImpl = (EStructuralFeature)feature;
}
}
return featureImpl;
}
/*
* (non-Javadoc)
*
* @see
* org.eclipse.papyrus.uml.diagram.sequence.parsers.AbstractParser#isAffectingEvent
* (java.lang.Object , int)
*/
public boolean isAffectingEvent(Object event, int flags) {
EStructuralFeature feature = getEStructuralFeature(event);
return isValidFeature(feature);
}
@Override
public String getEditString(IAdaptable adapter, int flags) {
return getPrintString(adapter, flags);
}
@Override
public ICommand getParseCommand(IAdaptable adapter, String newString, int flags) {
Object obj = adapter.getAdapter(EObject.class);
TransactionalEditingDomain editingDomain = TransactionUtil.getEditingDomain(obj);
if(editingDomain == null) {
return UnexecutableCommand.INSTANCE;
}
if(obj instanceof ValuePin) {
ValuePin pin = (ValuePin)obj;
ValueSpecification valueSpec = pin.getValue();
if(valueSpec != null) {
CompositeTransactionalCommand command = new CompositeTransactionalCommand(editingDomain, "Set Values"); //$NON-NLS-1$
command.compose(new CommandProxy(new SetValueSpecificationValueCommand(valueSpec, newString)));
return command;
}
} else if(obj instanceof ActionInputPin) {
ActionInputPin pin = (ActionInputPin)obj;
Action action = pin.getFromAction();
if(action instanceof ReadVariableAction) {
Variable variable = ((ReadVariableAction)action).getVariable();
if(variable != null) {
CompositeTransactionalCommand command = new CompositeTransactionalCommand(editingDomain, "Set Values"); //$NON-NLS-1$
command.compose(getModificationCommand(variable, UMLPackage.eINSTANCE.getNamedElement_Name(), newString));
return command;
}
} else if(action instanceof ReadSelfAction) {
return UnexecutableCommand.INSTANCE;
} else if(action instanceof ValueSpecificationAction) {
ValueSpecification valueSpec = ((ValueSpecificationAction)action).getValue();
if(valueSpec != null) {
CompositeTransactionalCommand command = new CompositeTransactionalCommand(editingDomain, "Set Values"); //$NON-NLS-1$
command.compose(new CommandProxy(new SetValueSpecificationValueCommand(valueSpec, newString)));
return command;
}
}
}
return UnexecutableCommand.INSTANCE;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.papyrus.uml.diagram.sequence.parsers.MessageFormatParser#
* getPrintString(org.eclipse .core.runtime.IAdaptable, int)
*/
public String getPrintString(IAdaptable element, int flags) {
// ensure valueLabel is never null
String valueLabel = " ";
Object obj = element.getAdapter(EObject.class);
if(obj instanceof ValuePin) {
ValuePin pin = (ValuePin)obj;
ValueSpecification valueSpec = pin.getValue();
if(valueSpec != null) {
String value = ValueSpecificationUtil.getSpecificationValue(valueSpec);
if(value != null) {
valueLabel = value;
}
}
} else if(obj instanceof ActionInputPin) {
ActionInputPin pin = (ActionInputPin)obj;
Action action = pin.getFromAction();
if(action instanceof ReadVariableAction) {
Variable variable = ((ReadVariableAction)action).getVariable();
if(variable != null) {
String value = variable.getName();
if(value != null) {
valueLabel = value;
}
}
} else if(action instanceof ReadSelfAction) {
valueLabel = SELF_KEYWORD;
} else if(action instanceof ValueSpecificationAction) {
ValueSpecification valueSpec = ((ValueSpecificationAction)action).getValue();
if(valueSpec != null) {
String value = ValueSpecificationUtil.getSpecificationValue(valueSpec);
if(value != null) {
valueLabel = value;
}
}
}
}
if(valueLabel.length() == 0) {
valueLabel = " ";
}
return valueLabel;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.gmf.runtime.emf.ui.services.parser.ISemanticParser#
* areSemanticElementsAffected (org.eclipse.emf.ecore.EObject,
* java.lang.Object)
*/
public boolean areSemanticElementsAffected(EObject listener, Object notification) {
EStructuralFeature feature = getEStructuralFeature(notification);
return isValidFeature(feature);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.gmf.runtime.emf.ui.services.parser.ISemanticParser#
* getSemanticElementsBeingParsed (org.eclipse.emf.ecore.EObject)
*/
public List<?> getSemanticElementsBeingParsed(EObject element) {
List<Element> semanticElementsBeingParsed = new ArrayList<Element>();
if(element instanceof Pin) {
Pin pin = (Pin)element;
semanticElementsBeingParsed.add(pin);
if(pin instanceof ValuePin) {
ValueSpecification valueSpec = ((ValuePin)pin).getValue();
if(valueSpec != null) {
semanticElementsBeingParsed.add(valueSpec);
}
} else if(pin instanceof ActionInputPin) {
Action action = ((ActionInputPin)pin).getFromAction();
if(action != null) {
semanticElementsBeingParsed.add(action);
}
if(action instanceof ReadVariableAction) {
Variable variable = ((ReadVariableAction)action).getVariable();
if(variable != null) {
semanticElementsBeingParsed.add(variable);
}
} else if(action instanceof ValueSpecificationAction) {
ValueSpecification valueSpec = ((ValueSpecificationAction)action).getValue();
if(valueSpec != null) {
semanticElementsBeingParsed.add(valueSpec);
}
}
}
}
return semanticElementsBeingParsed;
}
/**
* Determines if the given feature has to be taken into account in this
* parser
*
* @param feature
* the feature to test
* @return true if is valid, false otherwise
*/
private boolean isValidFeature(EStructuralFeature feature) {
return UMLPackage.eINSTANCE.getNamedElement_Name().equals(feature) || UMLPackage.eINSTANCE.getValuePin_Value().equals(feature) || UMLPackage.eINSTANCE.getActionInputPin_FromAction().equals(feature) || UMLPackage.eINSTANCE.getVariableAction_Variable().equals(feature) || UMLPackage.eINSTANCE.getValueSpecificationAction_Value().equals(feature) || ValueSpecification.class.isAssignableFrom(feature.getContainerClass());
}
}