Commit | Line | Data |
---|---|---|
c068a752 | 1 | /******************************************************************************* |
60ae41e1 | 2 | * Copyright (c) 2013, 2014 École Polytechnique de Montréal |
c068a752 GB |
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 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.internal.tmf.core.analysis; |
c068a752 | 14 | |
5db5a3a4 AM |
15 | import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull; |
16 | ||
b3b03da0 | 17 | import java.util.ArrayList; |
c068a752 GB |
18 | import java.util.LinkedList; |
19 | import java.util.List; | |
c068a752 GB |
20 | |
21 | import org.eclipse.core.runtime.IConfigurationElement; | |
22 | import org.eclipse.core.runtime.Platform; | |
2bdf0193 AM |
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; | |
c068a752 GB |
26 | |
27 | /** | |
b3b03da0 GB |
28 | * Utility class for accessing TMF analysis module extensions from the |
29 | * platform's extensions registry. | |
c068a752 GB |
30 | * |
31 | * @author Geneviève Bastien | |
c068a752 | 32 | */ |
b3b03da0 | 33 | public final class TmfAnalysisModuleSourceConfigElement implements IAnalysisModuleSource { |
c068a752 GB |
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 | ||
ff7b95a5 GB |
56 | /** Extension point attribute 'applies_experiment' */ |
57 | public static final String APPLIES_EXP_ATTR = "applies_experiment"; //$NON-NLS-1$ | |
58 | ||
c068a752 GB |
59 | /** Extension point attribute 'icon' */ |
60 | public static final String ICON_ATTR = "icon"; //$NON-NLS-1$ | |
61 | ||
62 | /** Extension point attribute 'default_value' */ | |
63 | public static final String DEFAULT_VALUE_ATTR = "default_value"; //$NON-NLS-1$ | |
64 | ||
65 | /** Extension point element 'tracetype' */ | |
66 | public static final String TRACETYPE_ELEM = "tracetype"; //$NON-NLS-1$ | |
67 | ||
68 | /** Extension point attribute 'class' */ | |
69 | public static final String CLASS_ATTR = "class"; //$NON-NLS-1$ | |
70 | ||
71 | /** Extension point attribute 'applies' */ | |
72 | public static final String APPLIES_ATTR = "applies"; //$NON-NLS-1$ | |
73 | ||
74 | /** | |
b3b03da0 | 75 | * The mapping of available analysis ID to their corresponding helper |
c068a752 | 76 | */ |
b3b03da0 | 77 | private final List<IAnalysisModuleHelper> fAnalysisHelpers = new ArrayList<>(); |
c068a752 GB |
78 | |
79 | /** | |
80 | * Retrieves all configuration elements from the platform extension registry | |
b3b03da0 | 81 | * for the analysis module extension. |
c068a752 | 82 | * |
b3b03da0 | 83 | * @return an array of analysis module configuration elements |
c068a752 GB |
84 | */ |
85 | public static IConfigurationElement[] getTypeElements() { | |
86 | IConfigurationElement[] elements = | |
87 | Platform.getExtensionRegistry().getConfigurationElementsFor(TMF_ANALYSIS_TYPE_ID); | |
a4524c1b | 88 | List<IConfigurationElement> typeElements = new LinkedList<>(); |
c068a752 GB |
89 | for (IConfigurationElement element : elements) { |
90 | if (element.getName().equals(MODULE_ELEM)) { | |
91 | typeElements.add(element); | |
92 | } | |
93 | } | |
5db5a3a4 | 94 | return checkNotNull(typeElements.toArray(new IConfigurationElement[typeElements.size()])); |
c068a752 GB |
95 | } |
96 | ||
c068a752 | 97 | /** |
b3b03da0 | 98 | * Constructor |
c068a752 | 99 | */ |
b3b03da0 GB |
100 | public TmfAnalysisModuleSourceConfigElement() { |
101 | populateAnalysisList(); | |
c068a752 GB |
102 | } |
103 | ||
b3b03da0 GB |
104 | @Override |
105 | public Iterable<IAnalysisModuleHelper> getAnalysisModules() { | |
106 | return fAnalysisHelpers; | |
c068a752 GB |
107 | } |
108 | ||
b3b03da0 GB |
109 | private void populateAnalysisList() { |
110 | if (fAnalysisHelpers.isEmpty()) { | |
111 | // Populate the analysis module list | |
c068a752 GB |
112 | IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor(TMF_ANALYSIS_TYPE_ID); |
113 | for (IConfigurationElement ce : config) { | |
114 | String elementName = ce.getName(); | |
b3b03da0 GB |
115 | if (elementName.equals(TmfAnalysisModuleSourceConfigElement.MODULE_ELEM)) { |
116 | fAnalysisHelpers.add(new TmfAnalysisModuleHelperConfigElement(ce)); | |
c068a752 GB |
117 | } |
118 | } | |
119 | } | |
120 | } | |
121 | ||
122 | } |