1 /*******************************************************************************
2 * Copyright (c) 2016 École Polytechnique de Montréal and others
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
10 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.ui
.module
;
16 import java
.io
.IOException
;
17 import java
.util
.List
;
20 import javax
.xml
.parsers
.DocumentBuilder
;
21 import javax
.xml
.parsers
.DocumentBuilderFactory
;
22 import javax
.xml
.parsers
.ParserConfigurationException
;
24 import org
.eclipse
.jdt
.annotation
.NonNull
;
25 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.core
.pattern
.stateprovider
.XmlPatternAnalysis
;
26 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.ui
.Activator
;
27 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.ui
.TmfXmlUiStrings
;
28 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.ui
.module
.Messages
;
29 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.ui
.views
.latency
.PatternLatencyTableView
;
30 import org
.eclipse
.tracecompass
.internal
.tmf
.analysis
.xml
.ui
.views
.xychart
.XmlXYView
;
31 import org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.core
.module
.XmlUtils
;
32 import org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.core
.stateprovider
.TmfXmlStrings
;
33 import org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.ui
.views
.timegraph
.XmlTimeGraphView
;
34 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisOutput
;
36 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.ITmfNewAnalysisModuleListener
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.ITmfAnalysisModuleWithStateSystems
;
38 import org
.w3c
.dom
.Document
;
39 import org
.w3c
.dom
.Element
;
40 import org
.w3c
.dom
.NodeList
;
41 import org
.xml
.sax
.SAXException
;
44 * This class searches all XML files to find outputs applicable to the newly
47 * @author Geneviève Bastien
49 public class TmfXmlAnalysisOutputSource
implements ITmfNewAnalysisModuleListener
{
51 /** String separating data elements for the output properties */
52 public static final @NonNull String DATA_SEPARATOR
= ";;;"; //$NON-NLS-1$
55 * Enum to match the name of a view's XML element to its view ID.
57 public static enum ViewType
{
59 * Time graph view element
61 TIME_GRAPH_VIEW(TmfXmlUiStrings
.TIME_GRAPH_VIEW
, XmlTimeGraphView
.ID
),
63 * XY chart view element
65 XY_VIEW(TmfXmlUiStrings
.XY_VIEW
, XmlXYView
.ID
);
67 private final @NonNull String fXmlElem
;
68 private final String fViewId
;
70 private ViewType(@NonNull String xmlElem
, String viewId
) {
76 * Get the XML element corresponding to this view type
78 * @return The XML element corresponding to this type
80 public @NonNull String
getXmlElem() {
84 private String
getViewId() {
90 * Enum for latency view type.
92 * @author Jean-Christian Kouame
96 public static enum LatencyViewType
{
99 * Latency Table View type
101 LATENCY_TABLE(PatternLatencyTableView
.ID
, Messages
.TmfXmlAnalysisOutputSource_LatencyTable
);
103 private @NonNull String fLatencyViewId
;
104 private String fLatencyViewLabel
;
106 private LatencyViewType(@NonNull String viewId
, String label
) {
107 fLatencyViewId
= viewId
;
108 fLatencyViewLabel
= label
;
112 * Get the ID of the latency view
116 public String
getViewId() {
117 return fLatencyViewId
;
121 * Get the label of the view
125 public String
getLabel() {
126 return fLatencyViewLabel
;
131 public void moduleCreated(IAnalysisModule module
) {
132 Map
<String
, File
> files
= XmlUtils
.listFiles();
133 for (File xmlFile
: files
.values()) {
134 if (!XmlUtils
.xmlValidate(xmlFile
).isOK()) {
139 /* Load the XML File */
140 DocumentBuilderFactory dbFactory
= DocumentBuilderFactory
.newInstance();
141 DocumentBuilder dBuilder
= dbFactory
.newDocumentBuilder();
142 Document doc
= dBuilder
.parse(xmlFile
);
143 doc
.getDocumentElement().normalize();
145 /* get state provider views if the analysis has state systems */
146 if (module
instanceof ITmfAnalysisModuleWithStateSystems
) {
147 for (ViewType viewType
: ViewType
.values()) {
148 NodeList ssViewNodes
= doc
.getElementsByTagName(viewType
.getXmlElem());
149 for (int i
= 0; i
< ssViewNodes
.getLength(); i
++) {
150 Element node
= (Element
) ssViewNodes
.item(i
);
152 /* Check if analysis is the right one */
153 List
<Element
> headNodes
= XmlUtils
.getChildElements(node
, TmfXmlStrings
.HEAD
);
154 if (headNodes
.size() != 1) {
158 List
<Element
> analysisNodes
= XmlUtils
.getChildElements(headNodes
.get(0), TmfXmlStrings
.ANALYSIS
);
159 for (Element analysis
: analysisNodes
) {
160 String analysisId
= analysis
.getAttribute(TmfXmlStrings
.ID
);
161 if (analysisId
.equals(module
.getId())) {
162 String viewId
= viewType
.getViewId();
163 IAnalysisOutput output
= new TmfXmlViewOutput(viewId
, viewType
);
164 output
.setOutputProperty(TmfXmlUiStrings
.XML_OUTPUT_DATA
, node
.getAttribute(TmfXmlStrings
.ID
) + DATA_SEPARATOR
+ xmlFile
.getAbsolutePath(), false);
165 module
.registerOutput(output
);
172 //Add the latency views for pattern analysis
173 if (module
instanceof XmlPatternAnalysis
) {
174 for (LatencyViewType viewType
: LatencyViewType
.values()) {
175 IAnalysisOutput output
= new TmfXmlLatencyViewOutput(viewType
.getViewId(), viewType
.getLabel());
176 output
.setOutputProperty(TmfXmlUiStrings
.XML_LATENCY_OUTPUT_DATA
, module
.getId() + DATA_SEPARATOR
+ viewType
.getLabel(), false);
177 module
.registerOutput(output
);
181 } catch (ParserConfigurationException
| SAXException
| IOException e
) {
182 Activator
.logError("Error opening XML file", e
); //$NON-NLS-1$