First cut at a Hints data structure

gselzer · hinerm · commit d7fbc08d136b · 2021-06-16T09:23:13.000-05:00
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/DefaultHints.java b/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/DefaultHints.java
@@ -0,0 +1,73 @@
+package org.scijava.ops.hints;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Optional;
+
+import org.scijava.ops.hints.DefaultOpHints.Adaptable;
+import org.scijava.ops.hints.DefaultOpHints.Simplifiable;
+
+/**
+ * Default Implementation of 
+ * @author G
+ *
+ */
+public class DefaultHints implements Hints {
+
+	private final Map<String, String> hints;
+
+	public DefaultHints() {
+		this(new String[] {Simplifiable.YES, Adaptable.YES});
+	}
+
+	public DefaultHints(String... startingHints) {
+		hints = new HashMap<>();
+		for(String hint : startingHints)
+			setHint(hint);
+	}
+
+	@Override
+	public String setHint(String hint) {
+		String[] hintParts = getHintParts(hint);
+		validateHintParts(hint, hintParts);
+		return hints.put(hintParts[0], hintParts[1]);
+	}
+
+	@Override
+	public boolean containsHintType(String hintType) {
+		String[] hintParts = getHintParts(hintType);
+		return hints.containsKey(hintParts[1]);
+	}
+
+	@Override
+	public boolean isActive(String hint) {
+		return hints.containsKey(hint);
+	}
+
+	@Override
+	public String getHint(String hintType) {
+		String[] hintParts = getHintParts(hintType);
+		if (!hints.containsKey(hintParts[1])) throw new NoSuchElementException(
+			"No hint of type " + hintType + " is contained!");
+		return buildHint(hintParts[0], hintParts[1], hints.get(hintParts[1]));
+		
+	}
+
+	private String buildHint(String base, String prefix, String suffix) {
+		return String.join(".", base, prefix, suffix);
+	}
+
+	private String[] getHintParts(String hint) {
+		return hint.split(".");
+	}
+
+	private void validateHintParts(String hint, String[] hintParts) {
+		if (hintParts.length != 3) throw new IllegalArgumentException("Hint " +
+			hint +
+			" does not conform to hint structure <Hints.BASE>.<hint_type>.<hint>!");
+		if (!hintParts[0].equals(Hints.BASE)) throw new IllegalArgumentException(
+			"Hint " + hint + " must begin with " + Hints.BASE);
+	}
+
+}
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/DefaultOpHints.java b/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/DefaultOpHints.java
@@ -0,0 +1,17 @@
+package org.scijava.ops.hints;
+
+public class DefaultOpHints {
+
+	public static class Simplifiable {
+		public static final String prefix = "simplification";
+		public static final String YES = Hints.BASE + "." + prefix + ".YES";
+		public static final String NO = Hints.BASE + "." + prefix + ".NO";
+	}
+
+	public static class Adaptable {
+		public static final String prefix = "adaptation";
+		public static final String YES = Hints.BASE + "." + prefix + ".YES";
+		public static final String NO = Hints.BASE + "." + prefix + ".NO";
+	}
+
+}
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/Hints.java b/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/Hints.java
@@ -0,0 +1,16 @@
+
+package org.scijava.ops.hints;
+
+public interface Hints {
+
+	public static final String BASE = "hints";
+
+	public String setHint(String hint);
+
+	public String getHint(String hintType);
+
+	public boolean isActive(String hint);
+
+	boolean containsHintType(String hintType);
+
+}
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/OpHints.java b/scijava/scijava-ops/src/main/java/org/scijava/ops/hints/OpHints.java
@@ -0,0 +1,12 @@
+
+package org.scijava.ops.hints;
+
+/**
+ * An annotation used to record the hints that apply to a particular Op.
+ * 
+ * @author Gabriel Selzer
+ */
+public @interface OpHints {
+
+	String[] hints() default {};
+}
