blob: 6ef85337cd56feb41b66f8800cc1bc6899421e09 (
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
206
207
208
209
210
211
212
213
214
|
/*******************************************************************************
* Copyright (c) 2011, 2012 THALES GLOBAL SERVICES.
* 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:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.sirius.diagram.sequence.business.internal.layout;
import java.util.Map;
import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import com.google.common.collect.Maps;
import org.eclipse.sirius.common.tools.api.util.Option;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.EndOfLife;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.ISequenceElement;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.InstanceRole;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.Lifeline;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.LostMessageEnd;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.Message;
import org.eclipse.sirius.diagram.sequence.business.internal.elements.SequenceDiagram;
import org.eclipse.sirius.diagram.sequence.business.internal.query.ISequenceElementQuery;
/**
* Computes the appropriate graphical locations of sequence events and lifelines
* on a sequence diagram to reflect the semantic order.
*
* @param <S>
* the layouted element type.
*
* @param <T>
* the layout data type.
*
* @author mporhel
*/
public abstract class AbstractSequenceLayout<S, T> {
/**
* The diagram to layout.
*/
protected final SequenceDiagram sequenceDiagram;
/**
* A map to register old layout data.
*/
protected final Map<ISequenceElement, T> oldLayoutData;
/**
* Constructor.
*
* @param sequenceDiagram
* the sequence diagram to layout.
*/
public AbstractSequenceLayout(SequenceDiagram sequenceDiagram) {
this.sequenceDiagram = sequenceDiagram;
this.oldLayoutData = Maps.newHashMap();
}
/**
* Compute and apply a specific layout. Should be use in a
* {@link org.eclipse.emf.transaction.RecordingCommand}.
*
* @param pack
* pack the space between instance roles.
*
* @return true if a layout was applied
*/
public final boolean layout(boolean pack) {
// initialisation
init(pack);
// vertical range computation
Map<? extends S, T> finalRanges = computeLayout(pack);
// Apply computed ranges
boolean applied = applyComputedLayout(finalRanges, pack);
dispose();
return applied;
}
/**
* Init the needed context for layout computation.
*
* @param pack
* pack the diagram
*/
protected abstract void init(boolean pack);
/**
* Get old layout data before layout application.
*
* @param ise
* the requested sequence element.
* @return the old layout data.
*/
protected abstract T getOldLayoutData(S ise);
/**
* Computes the absolute vertical (Y) location for all the messages in the
* sequence diagram.
*
* @param pack
* pack the diagram
* @return a map associating each message edit part to the new absolute
* vertical location it should have.
*/
protected abstract Map<? extends S, T> computeLayout(boolean pack);
/**
* Apply the computed layout.
*
* @param finalRanges
* a map associating each message edit part to the new absolute
* vertical location it should have.
* @param pack
* pack the diagram
*
* @return true if a layout was applied
*/
protected abstract boolean applyComputedLayout(Map<? extends S, T> finalRanges, boolean pack);
/**
* Dispose the layout context after layout application.
*/
protected void dispose() {
oldLayoutData.clear();
}
/**
* Return the non-explicitely created lifelines.
*
* @return the non-explicitely created lifelines.
*/
protected Iterable<Lifeline> getLifeLinesWithoutCreation() {
Predicate<Lifeline> isMainLifeline = new Predicate<Lifeline>() {
public boolean apply(Lifeline input) {
boolean main = true;
InstanceRole instanceRole = input.getInstanceRole();
if (instanceRole != null) {
main = !instanceRole.isExplicitlyCreated();
}
return main;
}
};
return Iterables.filter(sequenceDiagram.getAllLifelines(), isMainLifeline);
}
/**
* Return the non-explicitely destructed lifelines.
*
* @return the non-explicitely destructed lifelines.
*/
protected Iterable<Lifeline> getLifeLinesWithoutDestruction() {
Predicate<Lifeline> isLifelineWithoutDestruction = new Predicate<Lifeline>() {
public boolean apply(Lifeline input) {
boolean result = true;
// filter lifeline with endOfLife
Option<EndOfLife> endOfLife = input.getEndOfLife();
if (endOfLife.some()) {
result = !endOfLife.get().isExplicitelyDestroyed();
}
return result;
}
};
return Iterables.filter(sequenceDiagram.getAllLifelines(), isLifelineWithoutDestruction);
}
/**
* Check if the current lost end has been created from a tool application.
* Tool creation flags will be erased after the first layout.
*
* @param lostEnd
* the current end.
* @return true if the end was created by a tool.
*/
public static boolean createdFromTool(LostMessageEnd lostEnd) {
boolean toolCreated = false;
ISequenceElementQuery query = new ISequenceElementQuery(lostEnd);
if (query.hasAbsoluteBoundsFlag() && query.getFlaggedAbsoluteBounds().x == LayoutConstants.TOOL_CREATION_FLAG_FROM_SEMANTIC.x) {
toolCreated = true;
}
return toolCreated;
}
/**
* Check if the current lost end has been created from a tool application.
* Tool creation flags will be erased after the first layout.
*
* @param lostEnd
* the current end.
* @return true if the end was created by a tool.
*/
public static boolean createdFromExternalChange(LostMessageEnd lostEnd) {
boolean externalCreation = false;
Option<Message> message = lostEnd.getMessage();
ISequenceElementQuery query = new ISequenceElementQuery(lostEnd);
if (query.hasAbsoluteBoundsFlag() && query.getFlaggedAbsoluteBounds().x == LayoutConstants.EXTERNAL_CHANGE_FLAG.x) {
externalCreation = true;
} else if (message.some()) {
query = new ISequenceElementQuery(message.get());
externalCreation = query.hasAbsoluteBoundsFlag() && query.getFlaggedAbsoluteBounds().x == LayoutConstants.EXTERNAL_CHANGE_FLAG.x;
}
return externalCreation;
}
}
|
