1 /*******************************************************************************
\r
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
\r
3 * in Industry THTH ry.
\r
4 * All rights reserved. This program and the accompanying materials
\r
5 * are made available under the terms of the Eclipse Public License v1.0
\r
6 * which accompanies this distribution, and is available at
\r
7 * http://www.eclipse.org/legal/epl-v10.html
\r
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.project.internal;
\r
14 import java.util.ArrayList;
\r
15 import java.util.Arrays;
\r
16 import java.util.Collection;
\r
17 import java.util.HashSet;
\r
18 import java.util.Set;
\r
20 import org.eclipse.core.runtime.IConfigurationElement;
\r
21 import org.eclipse.core.runtime.IExtension;
\r
22 import org.eclipse.core.runtime.IExtensionPoint;
\r
23 import org.eclipse.core.runtime.Platform;
\r
24 import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;
\r
25 import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
\r
26 import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;
\r
27 import org.eclipse.core.runtime.dynamichelpers.IFilter;
\r
28 import org.simantics.project.features.registry.GroupReference;
\r
29 import org.simantics.project.features.registry.IProjectFeatureExtension;
\r
30 import org.simantics.project.features.registry.IProjectFeatureRegistry;
\r
31 import org.simantics.project.features.registry.InjectedDependency;
\r
32 import org.simantics.project.features.registry.ProjectFeatureReference;
\r
33 import org.simantics.utils.strings.StringUtils;
\r
36 * This registry implementation is not properly dynamic-enabled.
\r
37 * injectDependency is not handled well enough to work dynamically.
\r
39 * @author Tuukka Lehtonen
\r
41 public class ProjectFeatureRegistry implements IProjectFeatureRegistry, IExtensionChangeHandler {
\r
43 private final static String NAMESPACE = "org.simantics.project";
\r
45 private final static String EP_NAME = "feature";
\r
47 private final static String FEATURE = "feature";
\r
49 private final static String INJECT_DEPENDENCY = "injectDependency";
\r
51 private final ExtensionTracker tracker;
\r
53 private IProjectFeatureExtension[] extensions = new IProjectFeatureExtension[0];
\r
55 public ProjectFeatureRegistry() {
\r
56 tracker = new ExtensionTracker();
\r
58 // Cache defined actions
\r
59 IExtensionPoint expt = Platform.getExtensionRegistry().getExtensionPoint(NAMESPACE, EP_NAME);
\r
60 loadExtensions(expt.getConfigurationElements());
\r
62 // Start tracking for new and removed extensions
\r
63 IFilter filter = ExtensionTracker.createExtensionPointFilter(expt);
\r
64 tracker.registerHandler(this, filter);
\r
67 private void loadExtensions(IConfigurationElement[] configurationElements) {
\r
68 Set<IProjectFeatureExtension> newExtensions = new HashSet<IProjectFeatureExtension>(Arrays.asList(extensions));
\r
70 // These are all "feature" elements with required attributes
\r
73 for (IConfigurationElement el : configurationElements) {
\r
74 if (FEATURE.equals(el.getName())) {
\r
75 String id = StringUtils.safeString(el.getAttribute("id"));
\r
76 if (ProjectPolicy.TRACE_PROJECT_FEATURE_LOAD)
\r
77 System.out.println(this + " Trying to load project feature extension id '" + id + "' contributed by " + el.getContributor().getName());
\r
79 // Ignore extension without an ID
\r
80 // TODO: log warning
\r
81 if (ProjectPolicy.TRACE_PROJECT_FEATURE_LOAD)
\r
82 System.out.println(this + " skipping feature with empty ID contributed by " + el.getContributor().getName());
\r
85 if (StringUtils.safeString(el.getAttribute("class")).isEmpty()) {
\r
86 // Ignore extension without a feature class
\r
87 // TODO: log warning
\r
88 if (ProjectPolicy.TRACE_PROJECT_FEATURE_LOAD)
\r
89 System.out.println(this + " skipping feature missing 'class' attribute contributed by " + el.getContributor().getName());
\r
92 // Load optional attributes
\r
93 String label = StringUtils.safeString(el.getAttribute("label"));
\r
94 String description = StringUtils.safeString(el.getAttribute("description"));
\r
95 boolean published = "true".equalsIgnoreCase(el.getAttribute("published"));
\r
96 Collection<ProjectFeatureReference> requires = readProjectFeatureReferenceCollection(el, "requires");
\r
97 Collection<InjectedDependency> injections = readInjectedDependencies(el);
\r
98 Collection<GroupReference> installGroups = readGroupReferenceCollection(el, "installGroup");
\r
100 ProjectFeatureExtension ext = new ProjectFeatureExtension(el, id, label, description, published, requires, injections, installGroups);
\r
102 // Start tracking the new extension object, its removal will be notified of
\r
103 // with removeExtension(extension, Object[]).
\r
104 tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);
\r
106 newExtensions.add(ext);
\r
110 // Atomic assignment
\r
111 this.extensions = newExtensions.toArray(new IProjectFeatureExtension[newExtensions.size()]);
\r
114 private Collection<InjectedDependency> readInjectedDependencies(IConfigurationElement element) {
\r
115 Collection<InjectedDependency> result = new ArrayList<InjectedDependency>();
\r
117 for (IConfigurationElement child : element.getChildren(INJECT_DEPENDENCY)) {
\r
118 String id = StringUtils.safeString(child.getAttribute("id"));
\r
120 // Invalid extension
\r
123 String targetId = StringUtils.safeString(child.getAttribute("targetId"));
\r
124 if (targetId.isEmpty())
\r
125 // Invalid extension
\r
132 private Collection<ProjectFeatureReference> readProjectFeatureReferenceCollection(IConfigurationElement element, String childName) {
\r
133 Collection<ProjectFeatureReference> result = new ArrayList<ProjectFeatureReference>();
\r
135 for (IConfigurationElement child : element.getChildren(childName)) {
\r
136 String id = StringUtils.safeString(child.getAttribute("id"));
\r
137 if (id.isEmpty()) {
\r
138 // Invalid extension
\r
141 boolean optional = "true".equalsIgnoreCase( child.getAttribute("optional") );
\r
142 result.add(new ProjectFeatureReference(id, optional));
\r
148 private Collection<GroupReference> readGroupReferenceCollection(IConfigurationElement element, String childName) {
\r
149 Collection<GroupReference> result = new ArrayList<GroupReference>();
\r
151 for (IConfigurationElement child : element.getChildren(childName)) {
\r
152 String id = StringUtils.safeString(child.getAttribute("id"));
\r
153 if (id.isEmpty()) {
\r
154 // Invalid extension
\r
155 // TODO: log warning
\r
158 String version = StringUtils.safeString(child.getAttribute("version"));
\r
159 if (version.isEmpty())
\r
160 // Empty version implies no version, mark that with null.
\r
162 result.add(new GroupReference(id, version));
\r
169 public void addExtension(IExtensionTracker tracker, IExtension extension) {
\r
170 loadExtensions(extension.getConfigurationElements());
\r
174 public void removeExtension(IExtension extension, Object[] objects) {
\r
175 Set<IProjectFeatureExtension> newExtensions = new HashSet<IProjectFeatureExtension>(Arrays.asList(extensions));
\r
177 for (Object o : objects) {
\r
178 tracker.unregisterObject(extension, o);
\r
179 newExtensions.remove(o);
\r
182 // Atomic assignment
\r
183 this.extensions = newExtensions.toArray(new IProjectFeatureExtension[newExtensions.size()]);
\r
187 * @see org.simantics.project.IProjectFeatureRegistry#getExtensions()
\r
190 public IProjectFeatureExtension[] getExtensions() {
\r
195 public IProjectFeatureExtension getExtensionById(String id) {
\r
197 throw new IllegalArgumentException("null id");
\r
199 for (IProjectFeatureExtension ext : extensions) {
\r
200 if (id.equals(ext.getId()))
\r