org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/internal/tmf/core/analysis/TmfAnalysisModuleSourceConfigElement.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  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.internal.tmf.core.analysis;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import java.util.ArrayList;
  18 import java.util.LinkedList;
  19 import java.util.List;
  20
  21 import org.eclipse.core.runtime.IConfigurationElement;
  22 import org.eclipse.core.runtime.Platform;
  23 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleHelper;
  24 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModuleSource;
  25 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisModuleHelperConfigElement;
  26
  27 /**
  28  * Utility class for accessing TMF analysis module extensions from the
  29  * platform's extensions registry.
  30  *
  31  * @author Geneviève Bastien
  32  */
  33 public final class TmfAnalysisModuleSourceConfigElement implements IAnalysisModuleSource {
  34
  35     /** Extension point ID */
  36     public static final String TMF_ANALYSIS_TYPE_ID = "org.eclipse.linuxtools.tmf.core.analysis"; //$NON-NLS-1$
  37
  38     /** Extension point element 'module' */
  39     public static final String MODULE_ELEM = "module"; //$NON-NLS-1$
  40
  41     /** Extension point element 'parameter' */
  42     public static final String PARAMETER_ELEM = "parameter"; //$NON-NLS-1$
  43
  44     /** Extension point attribute 'ID' */
  45     public static final String ID_ATTR = "id"; //$NON-NLS-1$
  46
  47     /** Extension point attribute 'name' */
  48     public static final String NAME_ATTR = "name"; //$NON-NLS-1$
  49
  50     /** Extension point attribute 'analysis_module' */
  51     public static final String ANALYSIS_MODULE_ATTR = "analysis_module"; //$NON-NLS-1$
  52
  53     /** Extension point attribute 'automatic' */
  54     public static final String AUTOMATIC_ATTR = "automatic"; //$NON-NLS-1$
  55
  56     /** Extension point attribute 'icon' */
  57     public static final String ICON_ATTR = "icon"; //$NON-NLS-1$
  58
  59     /** Extension point attribute 'default_value' */
  60     public static final String DEFAULT_VALUE_ATTR = "default_value"; //$NON-NLS-1$
  61
  62     /** Extension point element 'tracetype' */
  63     public static final String TRACETYPE_ELEM = "tracetype"; //$NON-NLS-1$
  64
  65     /** Extension point attribute 'class' */
  66     public static final String CLASS_ATTR = "class"; //$NON-NLS-1$
  67
  68     /** Extension point attribute 'applies' */
  69     public static final String APPLIES_ATTR = "applies"; //$NON-NLS-1$
  70
  71     /**
  72      * The mapping of available analysis ID to their corresponding helper
  73      */
  74     private final List<IAnalysisModuleHelper> fAnalysisHelpers = new ArrayList<>();
  75
  76     /**
  77      * Retrieves all configuration elements from the platform extension registry
  78      * for the analysis module extension.
  79      *
  80      * @return an array of analysis module configuration elements
  81      */
  82     public static IConfigurationElement[] getTypeElements() {
  83         IConfigurationElement[] elements =
  84                 Platform.getExtensionRegistry().getConfigurationElementsFor(TMF_ANALYSIS_TYPE_ID);
  85         List<IConfigurationElement> typeElements = new LinkedList<>();
  86         for (IConfigurationElement element : elements) {
  87             if (element.getName().equals(MODULE_ELEM)) {
  88                 typeElements.add(element);
  89             }
  90         }
  91         return checkNotNull(typeElements.toArray(new IConfigurationElement[typeElements.size()]));
  92     }
  93
  94     /**
  95      * Constructor
  96      */
  97     public TmfAnalysisModuleSourceConfigElement() {
  98         populateAnalysisList();
  99     }
 100
 101     @Override
 102     public Iterable<IAnalysisModuleHelper> getAnalysisModules() {
 103         return fAnalysisHelpers;
 104     }
 105
 106     private void populateAnalysisList() {
 107         if (fAnalysisHelpers.isEmpty()) {
 108             // Populate the analysis module list
 109             IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor(TMF_ANALYSIS_TYPE_ID);
 110             for (IConfigurationElement ce : config) {
 111                 String elementName = ce.getName();
 112                 if (elementName.equals(TmfAnalysisModuleSourceConfigElement.MODULE_ELEM)) {
 113                     fAnalysisHelpers.add(new TmfAnalysisModuleHelperConfigElement(ce));
 114                 }
 115             }
 116         }
 117     }
 118
 119 }