Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: ef12f5154641361cceab578bb28711bb17d8b2d4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/**
 * Copyright (c) 2014 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.dd.di;

import org.eclipse.emf.common.util.EList;

import org.eclipse.emf.ecore.EObject;

/**
 * <!-- begin-user-doc --> A representation of the model object ' <em><b>Diagram Element</b></em>'. <!-- end-user-doc -->
 *
 * <!-- begin-model-doc -->
 * DiagramElement is the abstract super type of all elements in diagrams, including diagrams themselves. When contained in a diagram, diagram elements
 * are laid out relative to the diagram’s origin.
 * <!-- end-model-doc -->
 *
 * <p>
 * The following features are supported:
 * </p>
 * <ul>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getModelElement <em>Model Element</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getOwningDiagramElement <em>Owning Diagram Element</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getOwnedDiagramElement <em>Owned Diagram Element</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getLocalStyle <em>Local Style</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getSharedStyle <em>Shared Style</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getTargetEdge <em>Target Edge</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getSourceEdge <em>Source Edge</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.di.DiagramElement#getDiagram <em>Diagram</em>}</li>
 * </ul>
 *
 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement()
 * @model abstract="true"
 * @generated
 */
public interface DiagramElement extends EObject {

	/**
	 * Returns the value of the '<em><b>Model Element</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.emf.ecore.EObject}.
	 * This feature is a derived union.
	 * <!-- begin-user-doc --> <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * a reference to a depicted model element, which can be any MOF-based element
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Model Element</em>' reference list.
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_ModelElement()
	 * @model transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList<EObject> getModelElement();

	/**
	 * Returns the value of the '<em><b>Owning Diagram Element</b></em>' reference.
	 * It is bidirectional and its opposite is '{@link org.eclipse.papyrus.dd.di.DiagramElement#getOwnedDiagramElement <em>Owned Diagram Element</em>}
	 * '.
	 * This feature is a derived union.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * a reference to the diagram element that directly owns this diagram element.
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Owning Diagram Element</em>' reference.
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_OwningDiagramElement()
	 * @see org.eclipse.papyrus.dd.di.DiagramElement#getOwnedDiagramElement
	 * @model opposite="ownedDiagramElement" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
	 * @generated
	 */
	DiagramElement getOwningDiagramElement();

	/**
	 * Returns the value of the '<em><b>Owned Diagram Element</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.papyrus.dd.di.DiagramElement}.
	 * It is bidirectional and its opposite is '{@link org.eclipse.papyrus.dd.di.DiagramElement#getOwningDiagramElement
	 * <em>Owning Diagram Element</em>}'.
	 * This feature is a derived union.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * a collection of diagram elements that are directly owned by this diagram element.
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Owned Diagram Element</em>' reference list.
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_OwnedDiagramElement()
	 * @see org.eclipse.papyrus.dd.di.DiagramElement#getOwningDiagramElement
	 * @model opposite="owningDiagramElement" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList<DiagramElement> getOwnedDiagramElement();

	/**
	 * Returns the value of the '<em><b>Local Style</b></em>' containment
	 * reference. <!-- begin-user-doc --> <!-- end-user-doc --> <!--
	 * begin-model-doc --> a reference to an optional locally-owned style for
	 * this diagram element. <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Local Style</em>' containment reference.
	 * @see #setLocalStyle(Style)
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_LocalStyle()
	 * @model containment="true" ordered="false"
	 * @generated
	 */
	Style getLocalStyle();

	/**
	 * Returns the value of the '<em><b>Shared Style</b></em>' reference. <!--
	 * begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> a
	 * reference to an optional shared style element for this diagram element.
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Shared Style</em>' reference.
	 * @see #setSharedStyle(Style)
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_SharedStyle()
	 * @model ordered="false"
	 * @generated
	 */
	Style getSharedStyle();

	/**
	 * Returns the value of the '<em><b>Target Edge</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.papyrus.dd.di.Edge}.
	 * It is bidirectional and its opposite is '{@link org.eclipse.papyrus.dd.di.Edge#getTargetDiagramElement <em>Target Diagram Element</em>}'.
	 * This feature is a derived union.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * a collection of edges that reference this diagram element as a target.
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Target Edge</em>' reference list.
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_TargetEdge()
	 * @see org.eclipse.papyrus.dd.di.Edge#getTargetDiagramElement
	 * @model opposite="targetDiagramElement" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList<Edge> getTargetEdge();

	/**
	 * Returns the value of the '<em><b>Source Edge</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.papyrus.dd.di.Edge}.
	 * It is bidirectional and its opposite is '{@link org.eclipse.papyrus.dd.di.Edge#getSourceDiagramElement <em>Source Diagram Element</em>}'.
	 * This feature is a derived union.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * a collection of edges that reference this diagram element as a source.
	 * <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Source Edge</em>' reference list.
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_SourceEdge()
	 * @see org.eclipse.papyrus.dd.di.Edge#getSourceDiagramElement
	 * @model opposite="sourceDiagramElement" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList<Edge> getSourceEdge();

	/**
	 * Returns the value of the '<em><b>Diagram</b></em>' reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Diagram</em>' reference isn't clear, there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Diagram</em>' reference.
	 * @see #setDiagram(Diagram)
	 * @see org.eclipse.papyrus.dd.di.DIPackage#getDiagramElement_Diagram()
	 * @model required="true" transient="true" volatile="true" derived="true" ordered="false"
	 * @generated
	 */
	Diagram getDiagram();

	/**
	 * Sets the value of the '{@link org.eclipse.papyrus.dd.di.DiagramElement#getDiagram <em>Diagram</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * 
	 * @param value
	 *        the new value of the '<em>Diagram</em>' reference.
	 * @see #getDiagram()
	 * @generated
	 */
	void setDiagram(Diagram value);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * 
	 * @model required="true" ordered="false"
	 *        annotation=
	 *        "http://www.eclipse.org/emf/2002/Ecore/OCL body='if self.oclIsKindOf(Diagram) then \n\tself.oclAsType(Diagram)\nelse if self.owningDiagramElement->notEmpty() then\n\tself.owningDiagramElement.diagram\nelse\n\tnull\nendif endif'"
	 * @generated
	 */
	Diagram diagram();
} // DiagramElement

Back to the top