tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/analysis/TmfAnalysisModuleHelperConfigElement.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 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  *   Mathieu Rail - Added functionality for getting a module's requirements
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.tmf.core.analysis;
  15
  16 import java.util.Collections;
  17 import java.util.HashSet;
  18 import java.util.Set;
  19
  20 import org.eclipse.core.runtime.ContributorFactoryOSGi;
  21 import org.eclipse.core.runtime.CoreException;
  22 import org.eclipse.core.runtime.IConfigurationElement;
  23 import org.eclipse.core.runtime.InvalidRegistryObjectException;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.eclipse.tracecompass.internal.tmf.core.Activator;
  26 import org.eclipse.tracecompass.internal.tmf.core.analysis.TmfAnalysisModuleSourceConfigElement;
  27 import org.eclipse.tracecompass.tmf.core.analysis.requirements.TmfAbstractAnalysisRequirement;
  28 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  29 import org.eclipse.tracecompass.tmf.core.project.model.TmfTraceType;
  30 import org.eclipse.tracecompass.tmf.core.project.model.TraceTypeHelper;
  31 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  32 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
  33 import org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment;
  34 import org.osgi.framework.Bundle;
  35
  36 /**
  37  * Analysis module helper for modules provided by a plugin's configuration
  38  * elements.
  39  *
  40  * @author Geneviève Bastien
  41  */
  42 public class TmfAnalysisModuleHelperConfigElement implements IAnalysisModuleHelper {
  43
  44     private final IConfigurationElement fCe;
  45
  46     /**
  47      * Constructor
  48      *
  49      * @param ce
  50      *            The source {@link IConfigurationElement} of this module helper
  51      */
  52     public TmfAnalysisModuleHelperConfigElement(IConfigurationElement ce) {
  53         fCe = ce;
  54     }
  55
  56     // ----------------------------------------
  57     // Wrappers to {@link IAnalysisModule} methods
  58     // ----------------------------------------
  59
  60     @Override
  61     public String getId() {
  62         String id = fCe.getAttribute(TmfAnalysisModuleSourceConfigElement.ID_ATTR);
  63         if (id == null) {
  64             throw new IllegalStateException();
  65         }
  66         return id;
  67     }
  68
  69     @Override
  70     public String getName() {
  71         String name = fCe.getAttribute(TmfAnalysisModuleSourceConfigElement.NAME_ATTR);
  72         if (name == null) {
  73             throw new IllegalStateException();
  74         }
  75         return name;
  76     }
  77
  78     @Override
  79     public boolean isAutomatic() {
  80         return Boolean.parseBoolean(fCe.getAttribute(TmfAnalysisModuleSourceConfigElement.AUTOMATIC_ATTR));
  81     }
  82
  83     /**
  84      * @since 1.0
  85      */
  86     @Override
  87     public boolean appliesToExperiment() {
  88         return Boolean.parseBoolean(fCe.getAttribute(TmfAnalysisModuleSourceConfigElement.APPLIES_EXP_ATTR));
  89     }
  90
  91     @Override
  92     public String getHelpText() {
  93         /*
  94          * FIXME: No need to externalize this. A better solution will be found
  95          * soon and this string is just temporary
  96          */
  97         return "The trace must be opened to get the help message"; //$NON-NLS-1$
  98     }
  99
 100     @Override
 101     public String getIcon() {
 102         return fCe.getAttribute(TmfAnalysisModuleSourceConfigElement.ICON_ATTR);
 103     }
 104
 105     @Override
 106     public Bundle getBundle() {
 107         return ContributorFactoryOSGi.resolve(fCe.getContributor());
 108     }
 109
 110     private boolean appliesToTraceClass(Class<? extends ITmfTrace> traceclass) {
 111         boolean applies = false;
 112
 113         /* Get the module's applying tracetypes */
 114         final IConfigurationElement[] tracetypeCE = fCe.getChildren(TmfAnalysisModuleSourceConfigElement.TRACETYPE_ELEM);
 115         for (IConfigurationElement element : tracetypeCE) {
 116             Class<?> applyclass;
 117             try {
 118                 applyclass = getBundle().loadClass(element.getAttribute(TmfAnalysisModuleSourceConfigElement.CLASS_ATTR));
 119                 String classAppliesVal = element.getAttribute(TmfAnalysisModuleSourceConfigElement.APPLIES_ATTR);
 120                 boolean classApplies = true;
 121                 if (classAppliesVal != null) {
 122                     classApplies = Boolean.parseBoolean(classAppliesVal);
 123                 }
 124                 if (classApplies) {
 125                     applies |= applyclass.isAssignableFrom(traceclass);
 126                 } else {
 127                     /*
 128                      * If the trace type does not apply, reset the applies
 129                      * variable to false
 130                      */
 131                     if (applyclass.isAssignableFrom(traceclass)) {
 132                         applies = false;
 133                     }
 134                 }
 135             } catch (ClassNotFoundException | InvalidRegistryObjectException e) {
 136                 Activator.logError("Error in applies to trace", e); //$NON-NLS-1$
 137             }
 138         }
 139         return applies;
 140     }
 141
 142     @Override
 143     public boolean appliesToTraceType(Class<? extends ITmfTrace> traceclass) {
 144         boolean applies = appliesToTraceClass(traceclass);
 145
 146         /* Check if it applies to an experiment */
 147         if (!applies && TmfExperiment.class.isAssignableFrom(traceclass)) {
 148             applies = appliesToExperiment();
 149         }
 150         return applies;
 151     }
 152
 153     @Override
 154     public Iterable<Class<? extends ITmfTrace>> getValidTraceTypes() {
 155         Set<Class<? extends ITmfTrace>> traceTypes = new HashSet<>();
 156
 157         for (TraceTypeHelper tth : TmfTraceType.getTraceTypeHelpers()) {
 158             if (appliesToTraceType(tth.getTraceClass())) {
 159                 traceTypes.add(tth.getTraceClass());
 160             }
 161         }
 162
 163         return traceTypes;
 164     }
 165
 166     @Override
 167     public Iterable<TmfAbstractAnalysisRequirement> getAnalysisRequirements() {
 168         IAnalysisModule module = createModule();
 169         if (module != null) {
 170             return module.getAnalysisRequirements();
 171         }
 172         return Collections.EMPTY_SET;
 173
 174     }
 175
 176     // ---------------------------------------
 177     // Functionalities
 178     // ---------------------------------------
 179
 180     private IAnalysisModule createModule() {
 181         IAnalysisModule module = null;
 182         try {
 183             module = (IAnalysisModule) fCe.createExecutableExtension(TmfAnalysisModuleSourceConfigElement.ANALYSIS_MODULE_ATTR);
 184             module.setName(getName());
 185             module.setId(getId());
 186         } catch (CoreException e) {
 187             Activator.logError("Error getting analysis modules from configuration files", e); //$NON-NLS-1$
 188         }
 189         return module;
 190     }
 191
 192     @Override
 193     public IAnalysisModule newModule(ITmfTrace trace) throws TmfAnalysisException {
 194
 195         /* Check if it applies to trace itself */
 196         boolean applies = appliesToTraceClass(trace.getClass());
 197         /*
 198          * If the trace is an experiment, check if this module would apply to an
 199          * experiment should it apply to one of its traces.
 200          */
 201         if (!applies && (trace instanceof TmfExperiment) && appliesToExperiment()) {
 202             for (ITmfTrace expTrace : TmfTraceManager.getTraceSet(trace)) {
 203                 if (appliesToTraceClass(expTrace.getClass())) {
 204                     applies = true;
 205                     break;
 206                 }
 207             }
 208         }
 209
 210         if (!applies) {
 211             return null;
 212         }
 213
 214         IAnalysisModule module = createModule();
 215         if (module == null) {
 216             return null;
 217         }
 218
 219         module.setAutomatic(isAutomatic());
 220
 221         /* Get the module's parameters */
 222         final IConfigurationElement[] parametersCE = fCe.getChildren(TmfAnalysisModuleSourceConfigElement.PARAMETER_ELEM);
 223         for (IConfigurationElement element : parametersCE) {
 224             String paramName = element.getAttribute(TmfAnalysisModuleSourceConfigElement.NAME_ATTR);
 225             if (paramName == null) {
 226                 continue;
 227             }
 228             module.addParameter(paramName);
 229             String defaultValue = element.getAttribute(TmfAnalysisModuleSourceConfigElement.DEFAULT_VALUE_ATTR);
 230             if (defaultValue != null) {
 231                 module.setParameter(paramName, defaultValue);
 232             }
 233         }
 234         if (module.setTrace(trace)) {
 235             TmfAnalysisManager.analysisModuleCreated(module);
 236         } else {
 237             module.dispose();
 238             module = null;
 239         }
 240
 241         return module;
 242
 243     }
 244
 245     @Override
 246     public String getHelpText(@NonNull ITmfTrace trace) {
 247         IAnalysisModule module = createModule();
 248         if (module != null) {
 249             String ret = module.getHelpText(trace);
 250             module.dispose();
 251             return ret;
 252         }
 253         return getHelpText();
 254
 255     }
 256 }