all: merged the preservedProperties extension point into KLighD's

generic one.
kieler · NiklasRentzCAU · Sep 18, 2020 · Jun 12, 2019 · Jun 12, 2019 · Jun 12, 2019
commit 2773010f152ff15d9504682d91bcff831b288ae3
diff --git a/...kieler.klighd.incremental/src/de/cau/cs/kieler/klighd/incremental/merge/KGraphMerger.java b/...kieler.klighd.incremental/src/de/cau/cs/kieler/klighd/incremental/merge/KGraphMerger.java
@@ -452,10 +452,10 @@ private void updateGraphElement(final KGraphElement baseElement,
         // Do not remove properties that are set by the layout algorithm to save the position of a node.
 
         // Get properties that shall be preserved from ElkGraph to KGraph
-        List<IProperty<Object>> propertiesToPreserve = KlighdDataManager.getInstance().getPreservedProperties();
+        List<IProperty<?>> propertiesToPreserve = KlighdDataManager.getInstance().getPreservedProperties();
 
         // Preserve properties
-        for (IProperty<Object> property : propertiesToPreserve) {
+        for (IProperty<?> property : propertiesToPreserve) {
             removedProperties.remove(property);
         }
 

diff --git a/plugins/de.cau.cs.kieler.klighd.lsp/plugin.xml b/plugins/de.cau.cs.kieler.klighd.lsp/plugin.xml
@@ -2,17 +2,13 @@
 <?eclipse version="3.4"?>
 <plugin>
    <extension
-         point="de.cau.cs.kieler.klighd.preservedProperties">
-      <propertyList
-            class="de.cau.cs.kieler.klighd.lsp.interactive.rectpack.RectPackingPreservedProperties"
-            id="de.cau.cs.kieler.klighd.lsp.interactive.rectpack.RectPackingPreservedProperties"
-            name="RectPackingPreservedProperties">
-      </propertyList>
-      <propertyList
-            class="de.cau.cs.kieler.klighd.lsp.interactive.layered.LayeredPreservedProperties"
-            id="de.cau.cs.kieler.klighd.lsp.interactive.layered.LayeredPreservedProperties"
-            name="LayeredPreservedProperties">
-      </propertyList>
+         point="de.cau.cs.kieler.klighd.extensions">
+      <preservedProperties
+            class="de.cau.cs.kieler.klighd.lsp.interactive.layered.LayeredPreservedProperties">
+      </preservedProperties>
+      <preservedProperties
+            class="de.cau.cs.kieler.klighd.lsp.interactive.rectpack.RectPackingPreservedProperties">
+      </preservedProperties>
    </extension>
 
 </plugin>
diff --git a/...d.lsp/src/de/cau/cs/kieler/klighd/lsp/interactive/layered/LayeredPreservedProperties.java b/...d.lsp/src/de/cau/cs/kieler/klighd/lsp/interactive/layered/LayeredPreservedProperties.java
@@ -26,13 +26,13 @@
  * 
  * @author sdo
  */
-public class LayeredPreservedProperties implements IPreservedProperties<Integer> {
+public class LayeredPreservedProperties implements IPreservedProperties {
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public List<IProperty<Integer>> getProperties() {
+    public List<IProperty<?>> getProperties() {
         return Arrays.asList(LayeredOptions.LAYERING_LAYER_ID, LayeredOptions.CROSSING_MINIMIZATION_POSITION_ID);
     }
 

diff --git a/.../src/de/cau/cs/kieler/klighd/lsp/interactive/rectpack/RectPackingPreservedProperties.java b/.../src/de/cau/cs/kieler/klighd/lsp/interactive/rectpack/RectPackingPreservedProperties.java
@@ -26,13 +26,13 @@
  * 
  * @author sdo
  */
-public class RectPackingPreservedProperties implements IPreservedProperties<Integer> {
+public class RectPackingPreservedProperties implements IPreservedProperties {
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public List<IProperty<Integer>> getProperties() {
+    public List<IProperty<?>> getProperties() {
         return Arrays.asList(RectPackingOptions.CURRENT_POSITION);
     }
 

diff --git a/plugins/de.cau.cs.kieler.klighd/plugin.xml b/plugins/de.cau.cs.kieler.klighd/plugin.xml
@@ -3,7 +3,6 @@
 <plugin>
    <extension-point id="extensions" name="Compound extension point for all kinds of extensions" schema="schema/extensions.exsd"/>
    <extension-point id="diagramSyntheses" name="Diagram syntheses registering point" schema="schema/diagramSyntheses.exsd"/>
-   <extension-point id="de.cau.cs.kieler.klighd.preservedProperties" name="Preserved Properties" schema="schema/preservedProperties.exsd"/>
    <extension-point id="klighdStartupHook" name="Startup Hook for KLighD" schema="schema/klighdStartupHook.exsd"/>
    <extension
          point="org.eclipse.core.runtime.preferences">

diff --git a/plugins/de.cau.cs.kieler.klighd/schema/extensions.exsd b/plugins/de.cau.cs.kieler.klighd/schema/extensions.exsd
@@ -27,6 +27,7 @@
             <element ref="wrapper"/>
             <element ref="offscreenRenderer"/>
             <element ref="handler"/>
+            <element ref="preservedProperties"/>
          </choice>
          <attribute name="point" type="string" use="required">
             <annotation>
@@ -303,6 +304,21 @@ Note: Implementations should not directly implement the required interface but s
       </complexType>
    </element>
 
+   <element name="preservedProperties">
+      <complexType>
+         <attribute name="class" type="string" use="required">
+            <annotation>
+               <documentation>
+                  Class that provides properties which shall be preserved.
+               </documentation>
+               <appinfo>
+                  <meta.attribute kind="java" basedOn=":de.cau.cs.kieler.klighd.IPreservedProperties"/>
+               </appinfo>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
    <annotation>
       <appinfo>
          <meta.section type="since"/>

diff --git a/plugins/de.cau.cs.kieler.klighd/schema/preservedProperties.exsd b/plugins/de.cau.cs.kieler.klighd/schema/preservedProperties.exsd
diff --git a/plugins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/IPreservedProperties.java b/plugins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/IPreservedProperties.java
@@ -21,11 +21,13 @@
  * 
  * @author sdo
  */
-public interface IPreservedProperties<T> {
+public interface IPreservedProperties {
 
-    public static final String EXTENSION_POINT_ID = "de.cau.cs.kieler.klighd.preservedProperties";
-    public static final String ATTRIBUTE_ID = "id";
-
-    public List<IProperty<T>> getProperties();
+    /**
+     * A List of all properties that should be preserved.
+     * 
+     * @return The preserved properties.
+     */
+    public List<IProperty<?>> getProperties();
 
 }
diff --git a/plugins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/KlighdDataManager.java b/plugins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/KlighdDataManager.java
@@ -95,6 +95,9 @@ public final class KlighdDataManager {
 
     /** name of the 'offscreenRenderer' element. */
     private static final String ELEMENT_OFFSCREEN_RENDERER = "offscreenRenderer";
+
+    /** name of the 'preservedProperties' element. */
+    private static final String PRESERVED_PROPERTIES = "preservedProperties";
 
     /** name of the 'startupHook' element. */
     private static final String ELEMENT_STARTUP_HOOK = "startupHook";
@@ -219,7 +222,7 @@ public static KlighdDataManager getInstance() {
     private final List<CustomFigureWrapperDescriptor> customFigureWrapperMapping = Lists.newArrayList();
 
     /** the properties that shall be preserved from the layout graph to the kgraph */
-    private final List<IProperty<Object>> preservedProperties = Lists.newArrayList();
+    private final List<IProperty<?>> preservedProperties = Lists.newArrayList();
 
     /**
      * A private constructor to prevent instantiation.
@@ -231,7 +234,6 @@ private KlighdDataManager() {
         if (Klighd.IS_PLATFORM_RUNNING) {
             // load the data from the extension points
             loadKlighdExtensionsViaExtensionPoint();
-            loadPreservedPropertiesViaExtensionPoint();
             try {
                 loadDiagramSynthesesViaExtensionPoint(id2Synthesis, type2Syntheses);
 
@@ -247,7 +249,6 @@ private KlighdDataManager() {
         } else {
             loadDiagramSynthesesViaServiceLoader(id2Synthesis, type2Syntheses);
             loadKlighdExtensionsViaServiceLoader();
-            loadPreservedPropertiesViaServiceLoader();
         }
 
         this.idSynthesisMapping = id2Synthesis;
@@ -295,11 +296,19 @@ private void loadKlighdExtensionsViaExtensionPoint() {
             final String elementName = element.getName();
             final String id = element.getAttribute(ATTRIBUTE_ID);
 
-            // 'wrapper' extensions don't define an 'id' so check for that type of extension first
-            //  before checking for a valid id
+            // 'wrapper' and 'preservedProperties' extensions don't define an 'id' so check for that type of extension
+            // first before checking for a valid id
             if (ELEMENT_WRAPPER.equals(elementName)) {
                 registerCustomFigureWrapper(element);
 
+            } else if (PRESERVED_PROPERTIES.equals(elementName)) {
+                doRegisterExtension(element, IPreservedProperties.class,
+                        (preservedProperties) -> {
+                            for (IProperty<?> property : preservedProperties.getProperties()) {
+                                registerPreservedProperty(property);
+                            }
+                        });
+
             } else if (Strings.isNullOrEmpty(id)) {
                 final String msg = "KLighD: Found element of type '" + elementName
                         + "' extending extension point '" + EXTP_ID_EXTENSIONS
@@ -369,6 +378,12 @@ private void loadKlighdExtensionsViaServiceLoader() {
                 KlighdDataManager.class.getClassLoader())) {
             registerAction(action.getClass().getName(), action);
         }
+        for (IPreservedProperties preservedProperties : ServiceLoader.load(IPreservedProperties.class,
+                KlighdDataManager.class.getClassLoader())) {
+            for (IProperty<?> property : preservedProperties.getProperties()) {
+                registerPreservedProperty(property);
+            }
+        }
     }
 
     private <T> void doRegisterExtension(final IConfigurationElement element,
@@ -644,7 +659,7 @@ public KlighdDataManager registerDiagramSynthesisClass(final String id,
         return this;
     }
 
-    public KlighdDataManager registerPreservedProperties(IProperty<Object> preservedProperty) {
+    public KlighdDataManager registerPreservedProperty(IProperty<?> preservedProperty) {
         this.preservedProperties.add(preservedProperty);
         return this;
     }
@@ -1181,45 +1196,8 @@ public List<CustomFigureWrapperDescriptor> getCustomFigureWrapperDescriptors() {
      * 
      * @return the {@link List} of registered properties to preserve
      */
-    public List<IProperty<Object>> getPreservedProperties() {
+    public List<IProperty<?>> getPreservedProperties() {
         return this.preservedProperties;
     }
-
-    /**
-     * Loads all registered extensions from the extension point 'preservedProperties' and builds up the
-     * corresponding list of properties.
-     */
-    private void loadPreservedPropertiesViaExtensionPoint() {
-        final Iterable<IConfigurationElement> extensions = Iterables.filter(
-                Arrays.asList(
-                        Platform.getExtensionRegistry().getConfigurationElementsFor(IPreservedProperties.EXTENSION_POINT_ID)
-                ),
-                element -> true
-        );
-        for (IConfigurationElement element : extensions) {
-            try {
-                preservedProperties.addAll(
-                        ((IPreservedProperties<Object>) element.createExecutableExtension(IPreservedProperties.ATTRIBUTE_ID))
-                        .getProperties());
-            } catch (CoreException e) {
-                Klighd.handle(
-                        new Status(IStatus.ERROR, Klighd.PLUGIN_ID,
-                                KlighdDataManager.CORE_EXCEPTION_ERROR_MSG.replace("<<CLAZZ>>",
-                                        element.getAttribute("id")), e));
-            }
-        }
-    }
 
-    /**
-     * Loads the registered properties to preserve from the layout graph via Java {@link ServiceLoader}.
-     */
-    private void loadPreservedPropertiesViaServiceLoader() {
-        final Iterable<IPreservedProperties<Object>> listOfPropertyLists = Iterables.transform(
-                ServiceLoader.load(IPreservedProperties.class, KlighdDataManager.class.getClassLoader()),
-                s -> s
-        );
-        for (IPreservedProperties<Object> propertyList : listOfPropertyLists) {
-            preservedProperties.addAll(propertyList.getProperties());
-        }
-    }
 }
diff --git a/...klighd/src/de/cau/cs/kieler/klighd/internal/macrolayout/KlighdDiagramLayoutConnector.java b/...klighd/src/de/cau/cs/kieler/klighd/internal/macrolayout/KlighdDiagramLayoutConnector.java
@@ -679,12 +679,12 @@ public Boolean caseElkNode(final ElkNode layoutNode) {
                     final KNode node = (KNode) element;
 
                     // Get properties that shall be preserved from ElkGraph to KGraph
-                    List<IProperty<Object>> propertiesToPreserve = KlighdDataManager.getInstance().getPreservedProperties();
+                    List<IProperty<?>> propertiesToPreserve = KlighdDataManager.getInstance().getPreservedProperties();
 
                     // Preserve properties
-                    for (IProperty<Object> property : propertiesToPreserve) {
+                    for (IProperty<?> property : propertiesToPreserve) {
                         if (layoutNode.hasProperty(property)) {
-                            node.setProperty(property, layoutNode.getProperty(property));
+                            node.setProperty((IProperty<Object>) property, (Object) layoutNode.getProperty(property));
                         }
                     }