org.eclipse.linuxtools.tmf.analysis.xml.ui/src/org/eclipse/linuxtools/tmf/analysis/xml/ui/module/TmfXmlAnalysisOutputSource.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 École Polytechnique de Montréal
   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
  13 package org.eclipse.linuxtools.tmf.analysis.xml.ui.module;
  14
  15 import java.io.File;
  16 import java.io.IOException;
  17 import java.util.List;
  18
  19 import javax.xml.parsers.DocumentBuilder;
  20 import javax.xml.parsers.DocumentBuilderFactory;
  21 import javax.xml.parsers.ParserConfigurationException;
  22
  23 import org.eclipse.core.runtime.IPath;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.eclipse.linuxtools.internal.tmf.analysis.xml.ui.Activator;
  26 import org.eclipse.linuxtools.internal.tmf.analysis.xml.ui.TmfXmlUiStrings;
  27 import org.eclipse.linuxtools.internal.tmf.analysis.xml.ui.views.xychart.XmlXYView;
  28 import org.eclipse.linuxtools.tmf.analysis.xml.core.module.XmlUtils;
  29 import org.eclipse.linuxtools.tmf.analysis.xml.core.stateprovider.TmfXmlStrings;
  30 import org.eclipse.linuxtools.tmf.analysis.xml.ui.views.timegraph.XmlTimeGraphView;
  31 import org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule;
  32 import org.eclipse.linuxtools.tmf.core.analysis.IAnalysisOutput;
  33 import org.eclipse.linuxtools.tmf.core.analysis.ITmfNewAnalysisModuleListener;
  34 import org.eclipse.linuxtools.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  35 import org.w3c.dom.Document;
  36 import org.w3c.dom.Element;
  37 import org.w3c.dom.NodeList;
  38 import org.xml.sax.SAXException;
  39
  40 /**
  41  * This class searches all XML files to find outputs applicable to the newly
  42  * created analysis
  43  *
  44  * @author Geneviève Bastien
  45  */
  46 public class TmfXmlAnalysisOutputSource implements ITmfNewAnalysisModuleListener {
  47
  48     /** String separating data elements for the output properties */
  49     public static final String DATA_SEPARATOR = ";;;"; //$NON-NLS-1$
  50
  51     /**
  52      * Enum to match the name of a view's XML element to its view ID.
  53      * @since 1.2
  54      */
  55     public static enum ViewType {
  56         /**
  57          * Time graph view element
  58          */
  59         TIME_GRAPH_VIEW(TmfXmlUiStrings.TIME_GRAPH_VIEW, XmlTimeGraphView.ID),
  60         /**
  61          * XY chart view element
  62          */
  63         XY_VIEW(TmfXmlUiStrings.XY_VIEW, XmlXYView.ID);
  64
  65         private final @NonNull String fXmlElem;
  66         private final String fViewId;
  67
  68         private ViewType(@NonNull String xmlElem, String viewId) {
  69             fXmlElem = xmlElem;
  70             fViewId = viewId;
  71         }
  72
  73         /**
  74          * Get the XML element corresponding to this view type
  75          *
  76          * @return The XML element corresponding to this type
  77          */
  78         public @NonNull String getXmlElem() {
  79             return fXmlElem;
  80         }
  81
  82         private String getViewId() {
  83             return fViewId;
  84         }
  85     }
  86
  87
  88     @Override
  89     public void moduleCreated(IAnalysisModule module) {
  90         IPath pathToFiles = XmlUtils.getXmlFilesPath();
  91         File fFolder = pathToFiles.toFile();
  92         if (!(fFolder.isDirectory() && fFolder.exists())) {
  93             return;
  94         }
  95         for (File xmlFile : fFolder.listFiles()) {
  96             if (!XmlUtils.xmlValidate(xmlFile).isOK()) {
  97                 continue;
  98             }
  99
 100             try {
 101                 /* Load the XML File */
 102                 DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
 103                 DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
 104                 Document doc = dBuilder.parse(xmlFile);
 105                 doc.getDocumentElement().normalize();
 106
 107                 /* get state provider views if the analysis has state systems */
 108                 if (module instanceof TmfStateSystemAnalysisModule) {
 109                     for (ViewType viewType : ViewType.values()) {
 110                         NodeList ssViewNodes = doc.getElementsByTagName(viewType.getXmlElem());
 111                         for (int i = 0; i < ssViewNodes.getLength(); i++) {
 112                             Element node = (Element) ssViewNodes.item(i);
 113
 114                             /* Check if analysis is the right one */
 115                             List<Element> headNodes = XmlUtils.getChildElements(node, TmfXmlStrings.HEAD);
 116                             if (headNodes.size() != 1) {
 117                                 continue;
 118                             }
 119
 120                             List<Element> analysisNodes = XmlUtils.getChildElements(headNodes.get(0), TmfXmlStrings.ANALYSIS);
 121                             for (Element analysis : analysisNodes) {
 122                                 String analysisId = analysis.getAttribute(TmfXmlStrings.ID);
 123                                 if (analysisId.equals(module.getId())) {
 124                                     String viewId = viewType.getViewId();
 125                                     IAnalysisOutput output = new TmfXmlViewOutput(viewId, viewType);
 126                                     output.setOutputProperty(TmfXmlUiStrings.XML_OUTPUT_DATA, node.getAttribute(TmfXmlStrings.ID) + DATA_SEPARATOR + xmlFile.getAbsolutePath(), false);
 127                                     module.registerOutput(output);
 128                                 }
 129                             }
 130                         }
 131                     }
 132                 }
 133             } catch (ParserConfigurationException | SAXException | IOException e) {
 134                 Activator.logError("Error opening XML file", e); //$NON-NLS-1$
 135             }
 136         }
 137     }
 138
 139 }