Commit | Line | Data |
---|---|---|
87c5447c | 1 | /******************************************************************************* |
04927a83 | 2 | * Copyright (c) 2014, 2015 École Polytechnique de Montréal and others. |
87c5447c GB |
3 | * |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Geneviève Bastien - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.views.xychart; |
87c5447c | 14 | |
5db5a3a4 AM |
15 | import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull; |
16 | ||
87c5447c GB |
17 | import java.util.Collections; |
18 | import java.util.HashMap; | |
19 | import java.util.LinkedList; | |
20 | import java.util.List; | |
21 | import java.util.Map; | |
22 | import java.util.regex.Pattern; | |
23 | ||
24 | import org.eclipse.core.runtime.IProgressMonitor; | |
e1c415b3 | 25 | import org.eclipse.core.runtime.IStatus; |
4c4e2816 | 26 | import org.eclipse.jdt.annotation.NonNull; |
87c5447c | 27 | import org.eclipse.jdt.annotation.Nullable; |
87c5447c | 28 | import org.eclipse.swt.widgets.Composite; |
2bdf0193 AM |
29 | import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.Activator; |
30 | import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.TmfXmlUiStrings; | |
31 | import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.views.XmlViewInfo; | |
e894a508 AM |
32 | import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem; |
33 | import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException; | |
34 | import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException; | |
35 | import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException; | |
36 | import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException; | |
37 | import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue; | |
2bdf0193 AM |
38 | import org.eclipse.tracecompass.tmf.analysis.xml.core.model.ITmfXmlModelFactory; |
39 | import org.eclipse.tracecompass.tmf.analysis.xml.core.model.ITmfXmlStateAttribute; | |
40 | import org.eclipse.tracecompass.tmf.analysis.xml.core.model.TmfXmlLocation; | |
41 | import org.eclipse.tracecompass.tmf.analysis.xml.core.model.readonly.TmfXmlReadOnlyModelFactory; | |
42 | import org.eclipse.tracecompass.tmf.analysis.xml.core.module.IXmlStateSystemContainer; | |
43 | import org.eclipse.tracecompass.tmf.analysis.xml.core.module.XmlUtils; | |
44 | import org.eclipse.tracecompass.tmf.analysis.xml.core.stateprovider.TmfXmlStrings; | |
45 | import org.eclipse.tracecompass.tmf.core.statesystem.ITmfAnalysisModuleWithStateSystems; | |
2bdf0193 | 46 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
b8585c7c | 47 | import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils; |
2bdf0193 | 48 | import org.eclipse.tracecompass.tmf.ui.viewers.xycharts.linecharts.TmfCommonXLineChartViewer; |
87c5447c GB |
49 | import org.w3c.dom.Element; |
50 | ||
51 | /** | |
52 | * Main viewer to display XML-defined xy charts. It uses an XML | |
53 | * {@link TmfXmlUiStrings#XY_VIEW} element from an XML file. This element | |
54 | * defines which entries from the state system will be shown and also gives | |
55 | * additional information on the presentation of the view. | |
56 | * | |
57 | * @author Geneviève Bastien | |
58 | */ | |
59 | public class XmlXYViewer extends TmfCommonXLineChartViewer { | |
60 | ||
61 | private static final String SPLIT_STRING = "/"; //$NON-NLS-1$ | |
aae89862 PT |
62 | /** Timeout between updates in the updateData thread */ |
63 | private static final long BUILD_UPDATE_TIMEOUT = 500; | |
87c5447c | 64 | |
deab5300 | 65 | private static final Pattern WILDCARD_PATTERN = Pattern.compile("\\*"); //$NON-NLS-1$ |
87c5447c GB |
66 | |
67 | private final ITmfXmlModelFactory fFactory = TmfXmlReadOnlyModelFactory.getInstance(); | |
68 | private final Map<Integer, SeriesData> fSeriesData = new HashMap<>(); | |
69 | ||
70 | private final XmlViewInfo fViewInfo; | |
71 | ||
72 | /** XML Model elements to use to create the series */ | |
73 | private @Nullable ITmfXmlStateAttribute fDisplay; | |
74 | private @Nullable ITmfXmlStateAttribute fSeriesName; | |
75 | private @Nullable XmlXYEntry fEntry; | |
76 | ||
e2ea8484 GB |
77 | private enum DisplayType { |
78 | ABSOLUTE, | |
79 | DELTA | |
80 | } | |
81 | ||
87c5447c GB |
82 | /** |
83 | * The information related to one series on the chart | |
84 | */ | |
85 | private class SeriesData { | |
86 | ||
87 | private final double[] fYValues; | |
4c4e2816 | 88 | private final double @Nullable [] fYAbsoluteValues; |
87c5447c GB |
89 | private final Integer fDisplayQuark; |
90 | private final String fName; | |
e2ea8484 | 91 | private final DisplayType fType; |
87c5447c | 92 | |
e2ea8484 | 93 | public SeriesData(int length, int attributeQuark, String seriesName, DisplayType type) { |
87c5447c GB |
94 | fYValues = new double[length]; |
95 | fDisplayQuark = attributeQuark; | |
96 | fName = seriesName; | |
e2ea8484 GB |
97 | fType = type; |
98 | switch (fType) { | |
99 | case DELTA: | |
100 | fYAbsoluteValues = new double[length]; | |
101 | break; | |
102 | case ABSOLUTE: | |
103 | default: | |
104 | fYAbsoluteValues = null; | |
105 | break; | |
106 | } | |
107 | ||
87c5447c GB |
108 | } |
109 | ||
110 | public double[] getYValues() { | |
111 | return fYValues; | |
112 | } | |
113 | ||
114 | public Integer getDisplayQuark() { | |
115 | return fDisplayQuark; | |
116 | } | |
117 | ||
118 | public String getSeriesName() { | |
119 | return fName; | |
120 | } | |
121 | ||
122 | public void setYValue(int i, double yvalue) { | |
e2ea8484 GB |
123 | switch (fType) { |
124 | case DELTA: | |
125 | double[] absoluteVals = fYAbsoluteValues; | |
126 | if (absoluteVals == null) { | |
127 | throw new IllegalStateException(); | |
128 | } | |
129 | absoluteVals[i] = yvalue; | |
130 | /* | |
131 | * At the first timestamp, the delta value should be 0 since we | |
132 | * do not have the previous values | |
133 | */ | |
134 | double prevValue = yvalue; | |
135 | if (i > 0) { | |
136 | prevValue = absoluteVals[i - 1]; | |
137 | } | |
138 | fYValues[i] = yvalue - prevValue; | |
139 | break; | |
140 | case ABSOLUTE: | |
141 | default: | |
142 | fYValues[i] = yvalue; | |
143 | break; | |
144 | } | |
145 | ||
87c5447c GB |
146 | } |
147 | } | |
148 | ||
e2ea8484 | 149 | private static class XmlXYEntry implements IXmlStateSystemContainer { |
87c5447c GB |
150 | |
151 | private final ITmfStateSystem fStateSystem; | |
152 | private final String fPath; | |
e2ea8484 | 153 | private final DisplayType fType; |
87c5447c | 154 | |
e2ea8484 | 155 | public XmlXYEntry(ITmfStateSystem stateSystem, String path, Element entryElement) { |
87c5447c GB |
156 | fStateSystem = stateSystem; |
157 | fPath = path; | |
e2ea8484 GB |
158 | switch (entryElement.getAttribute(TmfXmlUiStrings.DISPLAY_TYPE)) { |
159 | case TmfXmlUiStrings.DISPLAY_TYPE_DELTA: | |
160 | fType = DisplayType.DELTA; | |
161 | break; | |
162 | case TmfXmlUiStrings.DISPLAY_TYPE_ABSOLUTE: | |
163 | default: | |
164 | fType = DisplayType.ABSOLUTE; | |
165 | break; | |
166 | } | |
87c5447c GB |
167 | } |
168 | ||
169 | @Override | |
170 | public @Nullable String getAttributeValue(@Nullable String name) { | |
171 | return name; | |
172 | } | |
173 | ||
174 | @Override | |
175 | public ITmfStateSystem getStateSystem() { | |
176 | return fStateSystem; | |
177 | } | |
178 | ||
179 | @Override | |
4c4e2816 | 180 | public @NonNull Iterable<@NonNull TmfXmlLocation> getLocations() { |
87c5447c GB |
181 | return Collections.EMPTY_SET; |
182 | } | |
183 | ||
e2ea8484 GB |
184 | public DisplayType getType() { |
185 | return fType; | |
186 | } | |
187 | ||
87c5447c GB |
188 | public List<Integer> getQuarks() { |
189 | /* Get the list of quarks to process with this path */ | |
190 | String[] paths = fPath.split(SPLIT_STRING); | |
0e4f957e | 191 | List<Integer> quarks = Collections.singletonList(IXmlStateSystemContainer.ROOT_QUARK); |
87c5447c GB |
192 | |
193 | try { | |
194 | for (String path : paths) { | |
195 | List<Integer> subQuarks = new LinkedList<>(); | |
196 | /* Replace * by .* to have a regex string */ | |
197 | String name = WILDCARD_PATTERN.matcher(path).replaceAll(".*"); //$NON-NLS-1$ | |
198 | for (int relativeQuark : quarks) { | |
199 | subQuarks.addAll(fStateSystem.getSubAttributes(relativeQuark, false, name)); | |
200 | } | |
201 | quarks = subQuarks; | |
202 | } | |
203 | } catch (AttributeNotFoundException e) { | |
204 | /* | |
205 | * We get all attributes from the state system itself, this | |
206 | * should not happen. | |
207 | */ | |
208 | throw new IllegalStateException(); | |
209 | } | |
210 | return quarks; | |
211 | } | |
212 | } | |
213 | ||
214 | /** | |
215 | * Constructor | |
216 | * | |
217 | * @param parent | |
218 | * parent view | |
219 | * @param viewInfo | |
220 | * The view info object | |
221 | */ | |
222 | public XmlXYViewer(@Nullable Composite parent, XmlViewInfo viewInfo) { | |
223 | super(parent, Messages.XmlXYViewer_DefaultViewerTitle, Messages.XmlXYViewer_DefaultXAxis, Messages.XmlXYViewer_DefaultYAxis); | |
224 | fViewInfo = viewInfo; | |
225 | } | |
226 | ||
227 | @Override | |
228 | protected void updateData(long start, long end, int nb, @Nullable IProgressMonitor monitor) { | |
229 | ||
230 | ITmfXmlStateAttribute display = fDisplay; | |
231 | ITmfXmlStateAttribute seriesNameAttrib = fSeriesName; | |
232 | XmlXYEntry entry = fEntry; | |
233 | if (getTrace() == null || display == null || entry == null) { | |
234 | return; | |
235 | } | |
236 | ITmfStateSystem ss = entry.getStateSystem(); | |
237 | ||
238 | double[] xvalues = getXAxis(start, end, nb); | |
239 | setXAxis(xvalues); | |
240 | ||
241 | boolean complete = false; | |
242 | long currentEnd = start; | |
243 | ||
244 | while (!complete && currentEnd < end) { | |
245 | if (monitor != null && monitor.isCanceled()) { | |
246 | return; | |
247 | } | |
248 | ||
aae89862 | 249 | complete = ss.waitUntilBuilt(BUILD_UPDATE_TIMEOUT); |
87c5447c GB |
250 | currentEnd = ss.getCurrentEndTime(); |
251 | try { | |
252 | List<Integer> quarks = entry.getQuarks(); | |
253 | long traceStart = getStartTime(); | |
254 | long traceEnd = getEndTime(); | |
255 | long offset = this.getTimeOffset(); | |
256 | ||
257 | /* Initialize quarks and series names */ | |
258 | for (int quark : quarks) { | |
259 | String seriesName = null; | |
260 | if (seriesNameAttrib == null) { | |
261 | seriesName = ss.getAttributeName(quark); | |
262 | } else { | |
263 | int seriesNameQuark = seriesNameAttrib.getAttributeQuark(quark); | |
264 | try { | |
265 | ITmfStateValue seriesNameValue = ss.querySingleState(start, seriesNameQuark).getStateValue(); | |
266 | if (!seriesNameValue.isNull()) { | |
e2ea8484 | 267 | seriesName = seriesNameValue.toString(); |
87c5447c GB |
268 | } |
269 | if (seriesName == null || seriesName.isEmpty()) { | |
270 | seriesName = ss.getAttributeName(quark); | |
271 | } | |
272 | } catch (TimeRangeException e) { | |
273 | /* | |
274 | * The attribute did not exist at this point, simply | |
275 | * use attribute name as series name | |
276 | */ | |
277 | seriesName = ss.getAttributeName(quark); | |
278 | } | |
279 | } | |
e2ea8484 | 280 | fSeriesData.put(quark, new SeriesData(xvalues.length, display.getAttributeQuark(quark), seriesName, entry.getType())); |
87c5447c GB |
281 | } |
282 | double yvalue = 0.0; | |
283 | for (int i = 0; i < xvalues.length; i++) { | |
284 | if (monitor != null && monitor.isCanceled()) { | |
285 | return; | |
286 | } | |
287 | double x = xvalues[i]; | |
288 | long time = (long) x + offset; | |
289 | // make sure that time is in the trace range after double to | |
290 | // long conversion | |
291 | time = time < traceStart ? traceStart : time; | |
292 | time = time > traceEnd ? traceEnd : time; | |
293 | ||
294 | for (int quark : quarks) { | |
202956f1 | 295 | SeriesData data = checkNotNull(fSeriesData.get(quark)); |
87c5447c | 296 | try { |
202956f1 AM |
297 | yvalue = ss.querySingleState(time, data.getDisplayQuark()).getStateValue().unboxLong(); |
298 | data.setYValue(i, yvalue); | |
87c5447c | 299 | } catch (TimeRangeException e) { |
202956f1 | 300 | data.setYValue(i, 0); |
87c5447c GB |
301 | } |
302 | } | |
303 | } | |
304 | for (int quark : quarks) { | |
202956f1 AM |
305 | SeriesData data = checkNotNull(fSeriesData.get(quark)); |
306 | setSeries(data.getSeriesName(), data.getYValues()); | |
87c5447c GB |
307 | } |
308 | updateDisplay(); | |
309 | } catch (AttributeNotFoundException | StateValueTypeException e) { | |
310 | Activator.logError("Error updating the data of XML XY view", e); //$NON-NLS-1$ | |
311 | } catch (StateSystemDisposedException e) { | |
312 | return; | |
313 | } | |
314 | } | |
315 | ||
316 | } | |
317 | ||
318 | @Override | |
319 | protected void initializeDataSource() { | |
320 | super.initializeDataSource(); | |
321 | ||
322 | ITmfTrace trace = this.getTrace(); | |
323 | if (trace == null) { | |
324 | return; | |
325 | } | |
326 | ||
327 | Element viewElement = fViewInfo.getViewElement(TmfXmlUiStrings.XY_VIEW); | |
328 | if (viewElement == null) { | |
329 | return; | |
330 | } | |
331 | ||
332 | Iterable<String> analysisIds = fViewInfo.getViewAnalysisIds(viewElement); | |
333 | ||
334 | List<ITmfAnalysisModuleWithStateSystems> stateSystemModules = new LinkedList<>(); | |
335 | if (!analysisIds.iterator().hasNext()) { | |
336 | /* | |
337 | * No analysis specified, take all state system analysis modules | |
338 | */ | |
b8585c7c | 339 | for (ITmfAnalysisModuleWithStateSystems module : TmfTraceUtils.getAnalysisModulesOfClass(trace, ITmfAnalysisModuleWithStateSystems.class)) { |
87c5447c GB |
340 | stateSystemModules.add(module); |
341 | } | |
342 | } else { | |
343 | for (String moduleId : analysisIds) { | |
b8585c7c | 344 | ITmfAnalysisModuleWithStateSystems module = TmfTraceUtils.getAnalysisModuleOfClass(trace, ITmfAnalysisModuleWithStateSystems.class, moduleId); |
87c5447c GB |
345 | if (module != null) { |
346 | stateSystemModules.add(module); | |
347 | } | |
348 | } | |
349 | } | |
350 | ||
351 | /** Initialize the data */ | |
352 | fDisplay = null; | |
353 | fSeriesName = null; | |
354 | ITmfStateSystem ss = null; | |
355 | fEntry = null; | |
356 | ||
357 | /* Schedule all state systems */ | |
358 | for (ITmfAnalysisModuleWithStateSystems module : stateSystemModules) { | |
e1c415b3 BH |
359 | IStatus status = module.schedule(); |
360 | if (!status.isOK()) { | |
361 | return; | |
362 | } | |
c81ffdf2 JCK |
363 | if (!module.waitForInitialization()) { |
364 | return; | |
87c5447c GB |
365 | } |
366 | for (ITmfStateSystem ssq : module.getStateSystems()) { | |
4c4e2816 AM |
367 | ss = ssq; |
368 | break; | |
87c5447c GB |
369 | } |
370 | } | |
371 | if (ss == null) { | |
372 | return; | |
373 | } | |
374 | ||
375 | /* | |
376 | * Initialize state attributes. There should be only one entry element | |
377 | * for XY charts. | |
378 | */ | |
379 | List<Element> entries = XmlUtils.getChildElements(viewElement, TmfXmlUiStrings.ENTRY_ELEMENT); | |
380 | Element entryElement = entries.get(0); | |
381 | String path = entryElement.getAttribute(TmfXmlUiStrings.PATH); | |
382 | if (path.isEmpty()) { | |
383 | path = TmfXmlStrings.WILDCARD; | |
384 | } | |
e2ea8484 | 385 | XmlXYEntry entry = new XmlXYEntry(ss, path, entryElement); |
87c5447c GB |
386 | fEntry = entry; |
387 | ||
388 | /* Get the display element to use */ | |
4c4e2816 | 389 | List<@NonNull Element> displayElements = XmlUtils.getChildElements(entryElement, TmfXmlUiStrings.DISPLAY_ELEMENT); |
87c5447c GB |
390 | if (displayElements.isEmpty()) { |
391 | Activator.logWarning(String.format("XML view: entry for %s should have a display element", path)); //$NON-NLS-1$ | |
392 | return; | |
393 | } | |
394 | Element displayElement = displayElements.get(0); | |
395 | fDisplay = fFactory.createStateAttribute(displayElement, entry); | |
396 | ||
397 | /* Get the series name element to use */ | |
398 | List<Element> seriesNameElements = XmlUtils.getChildElements(entryElement, TmfXmlUiStrings.NAME_ELEMENT); | |
399 | if (!seriesNameElements.isEmpty()) { | |
400 | Element seriesNameElement = seriesNameElements.get(0); | |
401 | fSeriesName = fFactory.createStateAttribute(seriesNameElement, entry); | |
402 | } | |
403 | ||
404 | } | |
405 | ||
406 | /** | |
407 | * Tells the viewer that the view info has been updated and the viewer needs | |
408 | * to be reinitialized | |
409 | */ | |
410 | public void viewInfoUpdated() { | |
411 | reinitialize(); | |
412 | } | |
413 | ||
414 | } |