| /* |
| * Copyright (c) 2005, 2011 IBM Corporation, CEA, and others. |
| * 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: |
| * IBM - initial API and implementation |
| * Kenn Hussey (CEA) - 327039 |
| * |
| * $Id: Vertex.java,v 1.13 2008/10/02 20:56:22 jbruck Exp $ |
| */ |
| package org.eclipse.uml2.uml; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| import org.eclipse.emf.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Vertex</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A vertex is an abstraction of a node in a state machine graph. In general, it can be the source or destination of any number of transitions. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.Vertex#getContainer <em>Container</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.Vertex#getIncomings <em>Incoming</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.Vertex#getOutgoings <em>Outgoing</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getVertex() |
| * @model abstract="true" |
| * @generated |
| */ |
| public interface Vertex |
| extends NamedElement { |
| |
| /** |
| * Returns the value of the '<em><b>Outgoing</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.Transition}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the transitions departing from this vertex. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Outgoing</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getVertex_Outgoing() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<Transition> getOutgoings(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Outgoing</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getOutgoings() |
| * @generated |
| */ |
| Transition getOutgoing(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Outgoing</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getOutgoings() |
| * @generated |
| */ |
| Transition getOutgoing(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Incoming</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.Transition}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the transitions entering this vertex. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Incoming</em>' reference list. |
| * @see org.eclipse.uml2.uml.UMLPackage#getVertex_Incoming() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<Transition> getIncomings(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Incoming</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getIncomings() |
| * @generated |
| */ |
| Transition getIncoming(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Incoming</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getIncomings() |
| * @generated |
| */ |
| Transition getIncoming(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Container</b></em>' container reference. |
| * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Region#getSubvertices <em>Subvertex</em>}'. |
| * <p> |
| * This feature subsets the following features: |
| * <ul> |
| * <li>'{@link org.eclipse.uml2.uml.NamedElement#getNamespace() <em>Namespace</em>}'</li> |
| * </ul> |
| * </p> |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The region that contains this vertex. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Container</em>' container reference. |
| * @see #setContainer(Region) |
| * @see org.eclipse.uml2.uml.UMLPackage#getVertex_Container() |
| * @see org.eclipse.uml2.uml.Region#getSubvertices |
| * @model opposite="subvertex" transient="false" ordered="false" |
| * @generated |
| */ |
| Region getContainer(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.Vertex#getContainer <em>Container</em>}' container reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Container</em>' container reference. |
| * @see #getContainer() |
| * @generated |
| */ |
| void setContainer(Region value); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The operation containingStateMachine() returns the state machine in which this Vertex is defined |
| * result = if not container->isEmpty() |
| * then |
| * -- the container is a region |
| * container.containingStateMachine() |
| * else if (oclIsKindOf(Pseudostate)) then |
| * -- entry or exit point? |
| * if (kind = #entryPoint) or (kind = #exitPoint) then |
| * stateMachine |
| * else if (oclIsKindOf(ConnectionPointReference)) then |
| * state.containingStateMachine() -- no other valid cases possible |
| * endif |
| * |
| * <!-- end-model-doc --> |
| * @model required="true" ordered="false" |
| * @generated |
| */ |
| StateMachine containingStateMachine(); |
| |
| } // Vertex |
