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