Initial idea for plug interfaces

orchestration-interfaces/pom.xml

@@ -28,6 +28,8 @@
             <version>${komet.version}</version>
             <scope>compile</scope>
         </dependency>
+
+
     </dependencies>
 
 </project>

orchestration-interfaces/src/main/java/dev/ikm/orchestration/interfaces/plugin/Plugin.java

@@ -0,0 +1,8 @@
+package dev.ikm.orchestration.interfaces.plugin;
+
+import java.util.UUID;
+
+public interface Plugin {
+
+
+}

plugin-impl/pom.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>dev.ikm</groupId>
+        <artifactId>ikm-framework</artifactId>
+        <version>3.0.1-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>plugin-impl</artifactId>
+
+    <name>plugin-impl</name>
+    <!-- FIXME change it to the project's website -->
+    <url>http://www.example.com</url>
+
+    <dependencies>
+        <dependency>
+            <groupId>dev.ikm.komet</groupId>
+            <artifactId>framework</artifactId>
+            <version>1.37.0-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+</project>

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/Plugin.java

@@ -0,0 +1,25 @@
+package dev.ikm.tinkar.plugin;
+
+import dev.ikm.komet.framework.events.EvtBus;
+import dev.ikm.komet.framework.events.EvtType;
+import dev.ikm.komet.preferences.KometPreferences;
+
+import java.util.List;
+import java.util.UUID;
+
+
+public interface Plugin {
+
+    UUID getId();
+
+    String getName();
+
+    void reconstruct(KometPreferences kometPreferences);
+
+    void register(EvtBus evtBus);
+
+    void registerTopics(EvtBus evtBus);
+
+    void unregister(EvtBus evtBus);
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/impl/AbstractConceptDetailWidget.java

@@ -0,0 +1,7 @@
+package dev.ikm.tinkar.plugin.impl;
+
+import dev.ikm.tinkar.plugin.type.Widget;
+
+@Widget
+public class AbstractConceptDetailWidget {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/ApplicationMenuBar.java

@@ -0,0 +1,4 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface ApplicationMenuBar {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/BumpOut.java

@@ -0,0 +1,5 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface BumpOut {
+    String iconPath() default "";
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/DoubleClick.java

@@ -0,0 +1,4 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface DoubleClick {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/DragAndDrop.java

@@ -0,0 +1,4 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface DragAndDrop {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/JournalCreateMenu.java

@@ -0,0 +1,4 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface JournalCreateMenu {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/JournalMenuBar.java

@@ -0,0 +1,6 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface JournalMenuBar {
+    String iconPath() default "";
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/interaction/RightClick.java

@@ -0,0 +1,4 @@
+package dev.ikm.tinkar.plugin.interaction;
+
+public @interface RightClick {
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Field.java

@@ -0,0 +1,6 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Field {
+    String fxml() default "";
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Menu.java

@@ -0,0 +1,5 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Menu {
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Style.java

@@ -0,0 +1,5 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Style {
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Task.java

@@ -0,0 +1,5 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Task {
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Widget.java

@@ -0,0 +1,6 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Widget {
+    String icon() default "";
+
+}

plugin-impl/src/main/java/dev/ikm/tinkar/plugin/type/Window.java

@@ -0,0 +1,6 @@
+package dev.ikm.tinkar.plugin.type;
+
+public @interface Window {
+    String icon() default "";
+
+}

plugin-impl/src/main/java/module-info.java

@@ -0,0 +1,9 @@
+module dev.ikm.tinkar.plugin {
+    requires dev.ikm.komet.framework;
+
+    exports dev.ikm.tinkar.plugin;
+    exports dev.ikm.tinkar.plugin.interaction;
+    exports dev.ikm.tinkar.plugin.impl;
+    exports dev.ikm.tinkar.plugin.type;
+
+}

plugin-impl/src/test/java/dev/ikm/tinkar/plugin/test/SimplePlugin.java

@@ -0,0 +1,51 @@
+package dev.ikm.tinkar.plugin.test;
+
+import dev.ikm.komet.framework.events.EvtBus;
+import dev.ikm.komet.framework.events.EvtType;
+import dev.ikm.komet.preferences.KometPreferences;
+import dev.ikm.tinkar.plugin.Plugin;
+import dev.ikm.tinkar.plugin.interaction.ApplicationMenuBar;
+import dev.ikm.tinkar.plugin.interaction.BumpOut;
+import dev.ikm.tinkar.plugin.type.Widget;
+
+import java.util.List;
+import java.util.UUID;
+
+@Widget
+@BumpOut
+@ApplicationMenuBar //TODO - with menu bar are we owning interconnection of plugins (i think no)
+public class SimplePlugin implements Plugin {
+
+    private static final String PLUGIN_NAME = "SimplePlugin";
+    private static final UUID PLUGIN_ID = UUID.randomUUID();
+
+    @Override
+    public UUID getId() {
+        return PLUGIN_ID;
+    }
+
+    @Override
+    public String getName() {
+        return PLUGIN_NAME;
+    }
+
+    @Override
+    public void reconstruct(KometPreferences kometPreferences) {
+
+    }
+
+    @Override
+    public void register(EvtBus evtBus) {
+        evtBus.subscribe(null, null, null);
+    }
+
+    @Override
+    public void unregister(EvtBus evtBus) {
+        evtBus.unsubscribe(null, null, null);
+    }
+
+    @Override
+    public void registerTopics(EvtBus evtBus) {
+
+    }
+}

plugin-impl/src/test/java/module-info.java

@@ -0,0 +1,6 @@
+module dev.ikm.tinkar.plugin.test {
+
+    requires dev.ikm.tinkar.plugin;
+    requires dev.ikm.komet.framework;
+
+}

pom.xml

@@ -37,5 +37,7 @@
              to modules that are plugins, but not dependencies (plugins are
              transparent to the build order) -->
         <module>komet-orchestrator</module>
+        <module>plugin-impl</module>
+
     </modules>
 </project>