Skip to content

Commit 45f4c15

Browse files
authored
Merge pull request #92 from scijava/scijava/scijava-ops-engine/info-tree-generator-extensible
Make InfoTreeGenerator Prioritized
2 parents 1f3cb53 + 5bd5a43 commit 45f4c15

2 files changed

Lines changed: 72 additions & 9 deletions

File tree

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/InfoTreeGenerator.java‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@
3636

3737
import org.scijava.ops.api.InfoTree;
3838
import org.scijava.ops.api.OpInfo;
39+
import org.scijava.priority.Prioritized;
40+
import org.scijava.priority.Priority;
3941

40-
public interface InfoTreeGenerator {
42+
public interface InfoTreeGenerator extends Prioritized<InfoTreeGenerator> {
4143

4244

4345
/**
@@ -68,13 +70,11 @@ static InfoTreeGenerator findSuitableGenerator(String signature,
6870
{
6971
List<InfoTreeGenerator> suitableGenerators = generators.stream() //
7072
.filter(g -> g.canGenerate(signature)) //
73+
.sorted() //
7174
.collect(Collectors.toList());
72-
if (suitableGenerators.size() == 0) throw new IllegalArgumentException(
75+
if (suitableGenerators.isEmpty()) throw new IllegalArgumentException(
7376
"No InfoTreeGenerator in given collection " + generators +
7477
" is able to reify signature " + signature);
75-
if (suitableGenerators.size() > 1) throw new IllegalArgumentException(
76-
"Signature " + signature +
77-
" is able to be reified by multiple generators: " + suitableGenerators);
7878
return suitableGenerators.get(0);
7979
}
8080

@@ -90,8 +90,8 @@ static InfoTree generateDependencyTree(String subsignature,
9090
* Finds the subsignature in {@link String} {@code signature}. The
9191
* subsignature is assumed to start at index {@code start}.
9292
*
93-
* @param signature
94-
* @param start
93+
* @param signature the signature containing a subsignature
94+
* @param start the index where the subsignature starts
9595
* @return a signature contained withing {@code signature}
9696
*/
9797
static String subSignatureFrom(String signature, int start) {
@@ -103,8 +103,7 @@ static String subSignatureFrom(String signature, int start) {
103103
else if (ch == InfoTree.DEP_END_DELIM) {
104104
depth--;
105105
if (depth == 0) {
106-
int depsEnd = i;
107-
return signature.substring(start, depsEnd + 1);
106+
return signature.substring(start, i + 1);
108107
}
109108
}
110109
}
@@ -124,4 +123,8 @@ else if (ch == InfoTree.DEP_END_DELIM) {
124123
*/
125124
boolean canGenerate(String signature);
126125

126+
@Override
127+
default double getPriority() {
128+
return Priority.NORMAL;
129+
}
127130
}
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
package org.scijava.ops.engine;
2+
3+
import java.util.Collection;
4+
import java.util.Map;
5+
import java.util.function.Function;
6+
7+
import org.junit.jupiter.api.Assertions;
8+
import org.junit.jupiter.api.BeforeAll;
9+
import org.junit.jupiter.api.Test;
10+
import org.scijava.ops.api.InfoTree;
11+
import org.scijava.ops.api.OpInfo;
12+
import org.scijava.ops.engine.matcher.impl.OpFieldInfo;
13+
import org.scijava.ops.spi.OpCollection;
14+
import org.scijava.ops.spi.OpField;
15+
import org.scijava.priority.Priority;
16+
17+
public class InfoTreeGeneratorTest extends AbstractTestEnvironment implements
18+
OpCollection
19+
{
20+
21+
@OpField(names="test.infoTreeGeneration")
22+
public final Function<Double, Double> foo = in -> in + 1;
23+
24+
@BeforeAll
25+
public static void addNeededOps() {
26+
ops.register(new DummyInfoTreeGenerator(), new InfoTreeGeneratorTest());
27+
}
28+
29+
30+
@Test
31+
public void testMultipleValidInfoTreeGenerators() {
32+
// Obtain a signature that can be reified by the DefaultInfoTreeGenerator and by our dummy generator
33+
var op = ops.unary("test.infoTreeGeneration").inType(Double.class).outType(Double.class).function();
34+
String signature = ops.history().signatureOf(op);
35+
// Run treeFromID to make sure our generator doesn't run
36+
var infoTree = ops.treeFromID(signature);
37+
// Assert non-null output
38+
Assertions.assertNotNull(infoTree);
39+
}
40+
41+
42+
static class DummyInfoTreeGenerator implements InfoTreeGenerator {
43+
44+
@Override
45+
public InfoTree generate(String signature, Map<String, OpInfo> idMap,
46+
Collection<InfoTreeGenerator> generators)
47+
{
48+
return null;
49+
}
50+
51+
@Override public boolean canGenerate(String signature) {
52+
return true;
53+
}
54+
55+
@Override public double getPriority() {
56+
return Priority.LOW;
57+
}
58+
59+
}
60+
}

0 commit comments

Comments
 (0)