1 /*******************************************************************************
2 * Copyright (c) 2013, 2014 École Polytechnique de Montréal
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
.internal
.tmf
.core
.analysis
;
15 import java
.util
.ArrayList
;
16 import java
.util
.LinkedList
;
17 import java
.util
.List
;
19 import org
.eclipse
.core
.runtime
.IConfigurationElement
;
20 import org
.eclipse
.core
.runtime
.Platform
;
21 import org
.eclipse
.jdt
.annotation
.NonNull
;
22 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModuleHelper
;
23 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModuleSource
;
24 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.TmfAnalysisModuleHelperConfigElement
;
27 * Utility class for accessing TMF analysis module extensions from the
28 * platform's extensions registry.
30 * @author Geneviève Bastien
33 public final class TmfAnalysisModuleSourceConfigElement
implements IAnalysisModuleSource
{
35 /** Extension point ID */
36 public static final String TMF_ANALYSIS_TYPE_ID
= "org.eclipse.linuxtools.tmf.core.analysis"; //$NON-NLS-1$
38 /** Extension point element 'module' */
39 public static final String MODULE_ELEM
= "module"; //$NON-NLS-1$
41 /** Extension point element 'parameter' */
42 public static final String PARAMETER_ELEM
= "parameter"; //$NON-NLS-1$
44 /** Extension point attribute 'ID' */
45 public static final String ID_ATTR
= "id"; //$NON-NLS-1$
47 /** Extension point attribute 'name' */
48 public static final String NAME_ATTR
= "name"; //$NON-NLS-1$
50 /** Extension point attribute 'analysis_module' */
51 public static final String ANALYSIS_MODULE_ATTR
= "analysis_module"; //$NON-NLS-1$
53 /** Extension point attribute 'automatic' */
54 public static final String AUTOMATIC_ATTR
= "automatic"; //$NON-NLS-1$
56 /** Extension point attribute 'icon' */
57 public static final String ICON_ATTR
= "icon"; //$NON-NLS-1$
59 /** Extension point attribute 'default_value' */
60 public static final String DEFAULT_VALUE_ATTR
= "default_value"; //$NON-NLS-1$
62 /** Extension point element 'tracetype' */
63 public static final String TRACETYPE_ELEM
= "tracetype"; //$NON-NLS-1$
65 /** Extension point attribute 'class' */
66 public static final String CLASS_ATTR
= "class"; //$NON-NLS-1$
68 /** Extension point attribute 'applies' */
69 public static final String APPLIES_ATTR
= "applies"; //$NON-NLS-1$
72 * The mapping of available analysis ID to their corresponding helper
74 private final List
<IAnalysisModuleHelper
> fAnalysisHelpers
= new ArrayList
<>();
77 * Retrieves all configuration elements from the platform extension registry
78 * for the analysis module extension.
80 * @return an array of analysis module configuration elements
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
);
91 @SuppressWarnings("null")
92 @NonNull IConfigurationElement
[] typeElems
= typeElements
.toArray(new IConfigurationElement
[typeElements
.size()]);
99 public TmfAnalysisModuleSourceConfigElement() {
100 populateAnalysisList();
104 public Iterable
<IAnalysisModuleHelper
> getAnalysisModules() {
105 return fAnalysisHelpers
;
108 private void populateAnalysisList() {
109 if (fAnalysisHelpers
.isEmpty()) {
110 // Populate the analysis module list
111 IConfigurationElement
[] config
= Platform
.getExtensionRegistry().getConfigurationElementsFor(TMF_ANALYSIS_TYPE_ID
);
112 for (IConfigurationElement ce
: config
) {
113 String elementName
= ce
.getName();
114 if (elementName
.equals(TmfAnalysisModuleSourceConfigElement
.MODULE_ELEM
)) {
115 fAnalysisHelpers
.add(new TmfAnalysisModuleHelperConfigElement(ce
));