add RectangularExtractor row provider

Author: nicolaspayette

POSEIDON/src/test/java/uk/ac/ox/oxfish/model/regs/factory/SpecificProtectedAreaFactoryTest.java

@@ -10,8 +10,8 @@
 import uk.ac.ox.oxfish.regulations.ForbiddenAreasFromShapeFiles;
 import uk.ac.ox.poseidon.agents.api.Action;
 import uk.ac.ox.poseidon.agents.core.BasicAction;
+import uk.ac.ox.poseidon.regulations.api.ConditionalRegulations;
 import uk.ac.ox.poseidon.regulations.api.Regulations;
-import uk.ac.ox.poseidon.regulations.core.ConditionalRegulations;
 import uk.ac.ox.poseidon.regulations.core.conditions.AllOf;
 import uk.ac.ox.poseidon.regulations.core.conditions.AnyOf;
 import uk.ac.ox.poseidon.regulations.core.conditions.InVectorField;
@@ -41,10 +41,10 @@ class SpecificProtectedAreaFactoryTest {
         ).apply(fishState);
     private final List<InVectorField> vectorFields =
         ((AnyOf) ((ConditionalRegulations) regulations).getCondition())
-            .getConditions()
+            .getSubConditions()
             .stream()
             .map(AllOf.class::cast)
-            .map(AllOf::getConditions)
+            .map(AllOf::getSubConditions)
             .flatMap(Collection::stream)
             .filter(InVectorField.class::isInstance)
             .map(InVectorField.class::cast)

epo/build.gradle.kts

@@ -4,5 +4,6 @@ plugins {
 
 dependencies {
     implementation(project(":POSEIDON"))
+    implementation(project(":regulations:core"))
     implementation("com.google.guava:guava:31.1-jre")
 }

epo/src/main/java/uk/ac/ox/poseidon/epo/RectangularAreaExtractor.java

@@ -0,0 +1,56 @@
+package uk.ac.ox.poseidon.epo;
+
+import com.google.common.collect.ImmutableList;
+import uk.ac.ox.oxfish.model.FishState;
+import uk.ac.ox.oxfish.model.data.monitors.loggers.RowProvider;
+import uk.ac.ox.poseidon.regulations.core.conditions.InRectangularArea;
+import uk.ac.ox.poseidon.regulations.api.ConditionalRegulations;
+import uk.ac.ox.poseidon.regulations.api.Regulations;
+import uk.ac.ox.poseidon.regulations.api.Condition;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public class RectangularAreaExtractor implements RowProvider {
+    private final Iterable<? extends Collection<?>> rows;
+
+    @Override
+    public List<String> getHeaders() {
+        return ImmutableList.of("min_lon", "max_lon", "min_lat", "max_lat");
+    }
+
+    @Override
+    public Iterable<? extends Collection<?>> getRows() {
+        return rows;
+    }
+
+    RectangularAreaExtractor(FishState fishState) {
+        this.rows =
+            extract(fishState.getRegulations(), Regulations::getSubRegulations)
+                .filter(ConditionalRegulations.class::isInstance)
+                .map(r -> ((ConditionalRegulations) r).getCondition())
+                .flatMap(c -> extract(c, Condition::getSubConditions))
+                .filter(InRectangularArea.class::isInstance)
+                .map(InRectangularArea.class::cast)
+                .map(rect -> ImmutableList.of(
+                    rect.getEnvelope().getMinX(),
+                    rect.getEnvelope().getMaxX(),
+                    rect.getEnvelope().getMinY(),
+                    rect.getEnvelope().getMaxY()
+                ))
+                .collect(Collectors.toList());
+    }
+
+    private static <T> Stream<T> extract(T obj, Function<T, ? extends Collection<T>> f) {
+        return Stream.concat(
+            Stream.of(obj),
+            f.apply(obj)
+                .stream()
+                .flatMap(sub -> extract(sub, f))
+        );
+    }
+
+}

regulations/api/src/main/java/uk/ac/ox/poseidon/regulations/api/Condition.java

@@ -2,8 +2,13 @@
 
 import uk.ac.ox.poseidon.agents.api.Action;
 
+import java.util.Collections;
+import java.util.Set;
 import java.util.function.Predicate;
 
 @FunctionalInterface
 public interface Condition extends Predicate<Action> {
+    default Set<Condition> getSubConditions() {
+        return Collections.emptySet();
+    }
 }

regulations/api/src/main/java/uk/ac/ox/poseidon/regulations/api/ConditionalOperator.java

@@ -0,0 +1,7 @@
+package uk.ac.ox.poseidon.regulations.api;
+
+import java.util.Set;
+
+public interface ConditionalOperator extends Condition {
+    Set<Condition> getSubConditions();
+}

regulations/api/src/main/java/uk/ac/ox/poseidon/regulations/api/ConditionalRegulations.java

@@ -0,0 +1,9 @@
+package uk.ac.ox.poseidon.regulations.api;
+
+public interface ConditionalRegulations extends Regulations {
+    Condition getCondition();
+
+    Regulations getRegulationIfTrue();
+
+    Regulations getRegulationIfFalse();
+}

regulations/api/src/main/java/uk/ac/ox/poseidon/regulations/api/Regulations.java

@@ -2,6 +2,9 @@
 
 import uk.ac.ox.poseidon.agents.api.Action;
 
+import java.util.Collection;
+import java.util.Collections;
+
 import static uk.ac.ox.poseidon.regulations.api.Mode.FORBIDDEN;
 import static uk.ac.ox.poseidon.regulations.api.Mode.MANDATORY;
 
@@ -23,4 +26,8 @@ default boolean isMandatory(final Action action) {
         return mode(action) == MANDATORY;
     }
 
+    default Collection<Regulations> getSubRegulations() {
+        return Collections.emptyList();
+    }
+
 }

regulations/core/src/main/java/uk/ac/ox/poseidon/regulations/core/AbstractCompositeRegulations.java

@@ -14,7 +14,7 @@ protected AbstractCompositeRegulations(
         this.subRegulations = ImmutableList.copyOf(subRegulations);
     }
 
-    protected Collection<Regulations> getSubRegulations() {
+    public Collection<Regulations> getSubRegulations() {
         return subRegulations;
     }
 

regulations/core/src/main/java/uk/ac/ox/poseidon/regulations/core/ConditionalRegulations.java

@@ -5,7 +5,7 @@
 import uk.ac.ox.poseidon.regulations.api.Mode;
 import uk.ac.ox.poseidon.regulations.api.Regulations;
 
-public class ConditionalRegulations implements Regulations {
+public class ConditionalRegulations implements uk.ac.ox.poseidon.regulations.api.ConditionalRegulations {
 
     private final Condition condition;
     private final Regulations regulationsIfTrue;
@@ -21,14 +21,17 @@ public ConditionalRegulations(
         this.regulationsIfFalse = regulationsIfFalse;
     }
 
+    @Override
     public Condition getCondition() {
         return condition;
     }
 
+    @Override
     public Regulations getRegulationIfTrue() {
         return regulationsIfTrue;
     }
 
+    @Override
     public Regulations getRegulationIfFalse() {
         return regulationsIfFalse;
     }

regulations/core/src/main/java/uk/ac/ox/poseidon/regulations/core/conditions/AllOf.java

@@ -1,33 +1,25 @@
 package uk.ac.ox.poseidon.regulations.core.conditions;
 
-import com.google.common.collect.ImmutableSet;
 import uk.ac.ox.poseidon.agents.api.Action;
 import uk.ac.ox.poseidon.regulations.api.Condition;
 
-import java.util.Collection;
 import java.util.Set;
 
-public class AllOf implements Condition {
+public class AllOf extends VariadicConditionalOperator {
 
-    private final Set<Condition> conditions;
-
-    public AllOf(final Collection<Condition> conditions) {
-        this.conditions = ImmutableSet.copyOf(conditions);
-    }
-
-    public Set<Condition> getConditions() {
-        return conditions;
+    public AllOf(Set<Condition> operands) {
+        super(operands);
     }
 
     @Override
     public boolean test(final Action action) {
-        return conditions.stream().allMatch(predicate -> predicate.test(action));
+        return getSubConditions().stream().allMatch(predicate -> predicate.test(action));
     }
 
     @Override
     public String toString() {
         return "AllOf{" +
-            "conditions=" + conditions +
+            "conditions=" + getSubConditions() +
             '}';
     }
 }