com.ibm.xtools.uml.redefinition

Class Redefinition

java.lang.Object

com.ibm.xtools.uml.redefinition.Redefinition

public class Redefinition
extends java.lang.Object

This class, while public, exists solely to advertise redefinition API and should not be implemented or extended by customers.

Method Summary

Modifier and Type	Method and Description
static org.eclipse.emf.ecore.EObject	getContextHint(java.util.Map<?,?> parameters) Retrieve the redefinition context hint from a parameter map
static org.eclipse.uml2.uml.Element	getRedefinitionChainHead(org.eclipse.uml2.uml.Element element) Follows the redefinition chain and returns the first fragment in the chain, the one who does not redefine any other element.
static org.eclipse.uml2.uml.Element	getRedefinitionChainTail(org.eclipse.uml2.uml.Element element, org.eclipse.emf.ecore.EObject contextHint) Finds an element that redefines the given element in the given context or the context closest to the given context
static java.util.List<? extends org.eclipse.uml2.uml.Element>	getReferencesTargets(java.util.Collection<? extends Inheritable<? extends org.eclipse.uml2.uml.Element,?>> candidates) Returns a list of semantic elements that the views should keep as their target.
static org.eclipse.uml2.uml.Element	getReferenceTarget(org.eclipse.uml2.uml.Element candidate, org.eclipse.emf.ecore.EObject contextHint) Returns semantic element that the view should keep as its target.
static boolean	isRedefinableProperty(org.eclipse.uml2.uml.Property property) Returns whether the specified property is redefinable according to this implementation's rules.
static boolean	isRedefinableStateMachine(org.eclipse.uml2.uml.StateMachine stateMachine) Returns whether the specified state machine is redefinable according to this implementation's rules.
static void	setContextHint(java.util.Map parameters, java.lang.Object contextHint) Set the redefinition context hint in a parameter map
static PortRedefinition	wrap(org.eclipse.uml2.uml.Port port, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a port.
static PropertyRedefinition<org.eclipse.uml2.uml.Property>	wrap(org.eclipse.uml2.uml.Property property, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a property.
static RegionRedefinition	wrap(org.eclipse.uml2.uml.Region region, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a region.
static StateRedefinition	wrap(org.eclipse.uml2.uml.State state, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a state.
static StateMachineRedefinition	wrap(org.eclipse.uml2.uml.StateMachine stateMachine, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a state machine.
static TransitionRedefinition	wrap(org.eclipse.uml2.uml.Transition transition, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a transition.
static InheritableVertex<org.eclipse.uml2.uml.Vertex>	wrap(org.eclipse.uml2.uml.Vertex vertex, org.eclipse.emf.ecore.EObject contextHint) Use the Redefinition Factory to create a redefinition aware wrapper for a vertex.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

wrap

public static StateMachineRedefinition wrap(org.eclipse.uml2.uml.StateMachine stateMachine,
                                            org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a state machine.

Parameters:

stateMachine - StateMachine to wrap

contextHint - Context for the redefinition

Returns:

A StateRedefinition that represents the provided state machine in the provided context

wrap

public static StateRedefinition wrap(org.eclipse.uml2.uml.State state,
                                     org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a state.

Parameters:

state - State to wrap

contextHint - Context for the redefinition

Returns:

A StateRedefinition that represents the provided state in the provided context

wrap

public static RegionRedefinition wrap(org.eclipse.uml2.uml.Region region,
                                      org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a region.

Parameters:

region - Region to wrap

contextHint - Context for the redefinition

Returns:

A RegionRedefinition that represents the provided region in the provided context

wrap

public static TransitionRedefinition wrap(org.eclipse.uml2.uml.Transition transition,
                                          org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a transition.

Parameters:

transition - Transition to wrap

contextHint - Context for the redefinition

Returns:

A TransitionRedefinition that represents the provided transition in the provided context

wrap

public static InheritableVertex<org.eclipse.uml2.uml.Vertex> wrap(org.eclipse.uml2.uml.Vertex vertex,
                                                                  org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a vertex.

Parameters:

vertex - Vertex to wrap

contextHint - Context for the redefinition

Returns:

A InheritableVertex that represents the provided vertex in the provided context

wrap

public static PropertyRedefinition<org.eclipse.uml2.uml.Property> wrap(org.eclipse.uml2.uml.Property property,
                                                                       org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a property.

Parameters:

property - Property to wrap

contextHint - EObject directly or indirectly owned by the redefinition context element or the redefinition context element itself

Returns:

A PropertyRedefinition that represents the provided property in the provided context

wrap

public static PortRedefinition wrap(org.eclipse.uml2.uml.Port port,
                                    org.eclipse.emf.ecore.EObject contextHint)

Use the Redefinition Factory to create a redefinition aware wrapper for a port.

Parameters:

port - Port to wrap

contextHint - EObject directly or indirectly owned by the redefinition context element or the redefinition context element itself

Returns:

A PortRedefinition that represents the provided property in the provided context

getRedefinitionChainHead

public static org.eclipse.uml2.uml.Element getRedefinitionChainHead(org.eclipse.uml2.uml.Element element)

Follows the redefinition chain and returns the first fragment in the chain, the one who does not redefine any other element.

Parameters:

element -

getRedefinitionChainTail

public static org.eclipse.uml2.uml.Element getRedefinitionChainTail(org.eclipse.uml2.uml.Element element,
                                                                    org.eclipse.emf.ecore.EObject contextHint)

Finds an element that redefines the given element in the given context or the context closest to the given context

Parameters:

element -

contextHint - is an EObject owned directly or indirectly by the redefinition context (StateMachine or Classifier)

getContextHint

public static org.eclipse.emf.ecore.EObject getContextHint(java.util.Map<?,?> parameters)

Retrieve the redefinition context hint from a parameter map

Parameters:

parameters - Request parameters

Returns:

The EObject that is the redefinition context for the request or null if it is not set

setContextHint

public static void setContextHint(java.util.Map parameters,
                                  java.lang.Object contextHint)

Set the redefinition context hint in a parameter map

Parameters:

parameters - Request parameters

contextHint - Context object

getReferencesTargets

public static java.util.List<? extends org.eclipse.uml2.uml.Element> getReferencesTargets(java.util.Collection<? extends Inheritable<? extends org.eclipse.uml2.uml.Element,?>> candidates)

Returns a list of semantic elements that the views should keep as their target.

Parameters:

candidates - the collection of inheritable elements that views would "normally" use or their redefinitions

getReferenceTarget

public static org.eclipse.uml2.uml.Element getReferenceTarget(org.eclipse.uml2.uml.Element candidate,
                                                              org.eclipse.emf.ecore.EObject contextHint)

Returns semantic element that the view should keep as its target.

Parameters:

candidate - the semantic element that view would "normally" use or its redefinition

contextHint - is an EObject owned directly or indirectly by the redefinition context (StateMachine or Classifier)

isRedefinableProperty

public static boolean isRedefinableProperty(org.eclipse.uml2.uml.Property property)

Returns whether the specified property is redefinable according to this implementation's rules.

Parameters:

property - Property to test

Returns:

true if the specified property is redefinable according to this implementation's rules, false otherwise

isRedefinableStateMachine

public static boolean isRedefinableStateMachine(org.eclipse.uml2.uml.StateMachine stateMachine)

Returns whether the specified state machine is redefinable according to this implementation's rules.

Parameters:

stateMachine - StateMachine to test

Returns:

true if the specified state machine is redefinable according to this implementation's rules, false otherwise