Merge pull request #84 from LionWeb-org/annotations

Annotations

Author: ftomassetti

core/src/main/java/io/lionweb/lioncore/java/api/ClassifierInstanceResolver.java

@@ -0,0 +1,26 @@
+package io.lionweb.lioncore.java.api;
+
+import io.lionweb.lioncore.java.model.ClassifierInstance;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/** This is able to find a Node or an Annotation Instance given its ID. */
+public interface ClassifierInstanceResolver {
+
+  /**
+   * This returns the Classifier Instance or null if the Classifier Instance cannot be found by this
+   * Classifier InstanceResolver.
+   */
+  @Nullable
+  ClassifierInstance<?> resolve(String instanceID);
+
+  @Nonnull
+  default ClassifierInstance<?> strictlyResolve(String instanceID) {
+    ClassifierInstance<?> partial = resolve(instanceID);
+    if (partial == null) {
+      throw new UnresolvedClassifierInstanceException(instanceID);
+    } else {
+      return partial;
+    }
+  }
+}

core/src/main/java/io/lionweb/lioncore/java/api/CompositeClassifierInstanceResolver.java

@@ -0,0 +1,43 @@
+package io.lionweb.lioncore.java.api;
+
+import io.lionweb.lioncore.java.model.ClassifierInstance;
+import java.util.ArrayList;
+import java.util.List;
+import javax.annotation.Nullable;
+
+/** This combines several ClassifierInstanceResolvers. */
+public class CompositeClassifierInstanceResolver implements ClassifierInstanceResolver {
+  private List<ClassifierInstanceResolver> classifierInstanceResolvers = new ArrayList<>();
+
+  public CompositeClassifierInstanceResolver() {}
+
+  public CompositeClassifierInstanceResolver(
+      ClassifierInstanceResolver... classifierInstanceResolvers) {
+    for (ClassifierInstanceResolver classifierInstanceResolver : classifierInstanceResolvers) {
+      add(classifierInstanceResolver);
+    }
+  }
+
+  public CompositeClassifierInstanceResolver add(
+      ClassifierInstanceResolver classifierInstanceResolver) {
+    classifierInstanceResolvers.add(classifierInstanceResolver);
+    return this;
+  }
+
+  @Nullable
+  @Override
+  public ClassifierInstance<?> resolve(String instanceID) {
+    for (ClassifierInstanceResolver classifierInstanceResolver : classifierInstanceResolvers) {
+      ClassifierInstance<?> instance = classifierInstanceResolver.resolve(instanceID);
+      if (instance != null) {
+        return instance;
+      }
+    }
+    return null;
+  }
+
+  @Override
+  public String toString() {
+    return "CompositeClassifierInstanceResolver(" + classifierInstanceResolvers + ")";
+  }
+}

core/src/main/java/io/lionweb/lioncore/java/api/CompositeNodeResolver.java

@@ -0,0 +1,47 @@
+package io.lionweb.lioncore.java.api;
+
+import io.lionweb.lioncore.java.model.ClassifierInstance;
+import io.lionweb.lioncore.java.model.Node;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/**
+ * This NodeResolver consult a given list of classifier instances to find the one with the requested
+ * ID.
+ */
+public class LocalClassifierInstanceResolver implements ClassifierInstanceResolver {
+  private Map<String, ClassifierInstance<?>> instances = new HashMap<>();
+
+  public LocalClassifierInstanceResolver() {}
+
+  public LocalClassifierInstanceResolver(List<ClassifierInstance<?>> instances) {
+    instances.forEach(n -> add(n));
+  }
+
+  public void add(@Nonnull ClassifierInstance<?> instance) {
+    instances.put(instance.getID(), instance);
+  }
+
+  @Nullable
+  @Override
+  public ClassifierInstance<?> resolve(String instanceID) {
+    return instances.get(instanceID);
+  }
+
+  public void addAll(@Nonnull List<? extends ClassifierInstance<?>> instances) {
+    instances.forEach(n -> add(n));
+  }
+
+  @Override
+  public String toString() {
+    return "LocalClassifierInstanceResolver(" + instances.keySet() + ")";
+  }
+
+  public void addTree(@Nonnull Node root) {
+    add(root);
+    root.getChildren().forEach(c -> addTree(c));
+  }
+}

core/src/main/java/io/lionweb/lioncore/java/api/LocalClassifierInstanceResolver.java

@@ -0,0 +1,13 @@
+package io.lionweb.lioncore.java.api;
+
+public class UnresolvedClassifierInstanceException extends RuntimeException {
+  private String instanceID;
+
+  public String getInstanceID() {
+    return instanceID;
+  }
+
+  public UnresolvedClassifierInstanceException(String instanceID) {
+    super("Unable to resolve classifier instance with ID=" + instanceID);
+  }
+}