create new regulations subproject

poseidon-fisheries · Feb 6, 2025 · 4cc6371 · 4cc6371
1 parent c501b9b
commit 4cc6371
Show file tree

Hide file tree

Showing 47 changed files with 85 additions and 104 deletions.
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/modules/agents/POSEIDON.agents.main.iml b/.idea/modules/agents/POSEIDON.agents.main.iml
diff --git a/.idea/modules/biology/POSEIDON.biology.main.iml b/.idea/modules/biology/POSEIDON.biology.main.iml
diff --git a/.idea/modules/core/POSEIDON.core.main.iml b/.idea/modules/core/POSEIDON.core.main.iml
diff --git a/.idea/modules/examples/POSEIDON.examples.main.iml b/.idea/modules/examples/POSEIDON.examples.main.iml
diff --git a/.idea/modules/geography/POSEIDON.geography.main.iml b/.idea/modules/geography/POSEIDON.geography.main.iml
diff --git a/.idea/modules/gui/POSEIDON.gui.main.iml b/.idea/modules/gui/POSEIDON.gui.main.iml
diff --git a/.idea/modules/io/POSEIDON.io.main.iml b/.idea/modules/io/POSEIDON.io.main.iml
diff --git a/.idea/modules/regulations/POSEIDON.regulations.main.iml b/.idea/modules/regulations/POSEIDON.regulations.main.iml
diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts
@@ -24,7 +24,7 @@ plugins {
 }
 
 dependencies {
-    implementation(project(":agents"))
+    implementation(project(":regulations"))
     implementation(project(":biology"))
     implementation(project(":io"))
     implementation(project(":gui"))

diff --git a/examples/src/main/java/uk/ac/ox/poseidon/examples/BasicScenario.java b/examples/src/main/java/uk/ac/ox/poseidon/examples/BasicScenario.java
@@ -42,8 +42,6 @@
 import uk.ac.ox.poseidon.agents.registers.Register;
 import uk.ac.ox.poseidon.agents.registers.RegisterFactory;
 import uk.ac.ox.poseidon.agents.registers.RegisteringFactory;
-import uk.ac.ox.poseidon.agents.regulations.AlwaysPermittedFactory;
-import uk.ac.ox.poseidon.agents.regulations.FishingLocationLegalityCheckerFactory;
 import uk.ac.ox.poseidon.agents.tables.FishingActionListenerTableFactory;
 import uk.ac.ox.poseidon.agents.vessels.RandomHomePortFactory;
 import uk.ac.ox.poseidon.agents.vessels.VesselFactory;
@@ -83,6 +81,8 @@
 import uk.ac.ox.poseidon.io.ScenarioWriter;
 import uk.ac.ox.poseidon.io.tables.CsvTableWriter;
 import uk.ac.ox.poseidon.io.tables.CsvTableWriterFactory;
+import uk.ac.ox.poseidon.regulations.AlwaysPermittedFactory;
+import uk.ac.ox.poseidon.regulations.FishingLocationLegalityCheckerFactory;
 
 import java.nio.file.Path;
 import java.time.LocalDate;

diff --git a/examples/src/main/java/uk/ac/ox/poseidon/examples/external/ExternalScenario.java b/examples/src/main/java/uk/ac/ox/poseidon/examples/external/ExternalScenario.java
@@ -42,8 +42,6 @@
 import uk.ac.ox.poseidon.agents.registers.Register;
 import uk.ac.ox.poseidon.agents.registers.RegisterFactory;
 import uk.ac.ox.poseidon.agents.registers.RegisteringFactory;
-import uk.ac.ox.poseidon.agents.regulations.FishingLocationLegalityCheckerFactory;
-import uk.ac.ox.poseidon.agents.regulations.NeverPermittedFactory;
 import uk.ac.ox.poseidon.agents.tables.FishingActionListenerTableFactory;
 import uk.ac.ox.poseidon.agents.vessels.RandomHomePortFactory;
 import uk.ac.ox.poseidon.agents.vessels.VesselFactory;
@@ -82,6 +80,8 @@
 import uk.ac.ox.poseidon.io.ScenarioWriter;
 import uk.ac.ox.poseidon.io.tables.CsvTableWriter;
 import uk.ac.ox.poseidon.io.tables.CsvTableWriterFactory;
+import uk.ac.ox.poseidon.regulations.FishingLocationLegalityCheckerFactory;
+import uk.ac.ox.poseidon.regulations.NeverPermittedFactory;
 
 import java.nio.file.Path;
 import java.time.LocalDate;

diff --git a/regulations/build.gradle.kts b/regulations/build.gradle.kts
@@ -0,0 +1,27 @@
+/*
+ * POSEIDON: an agent-based model of fisheries
+ * Copyright (c) 2025 CoHESyS Lab [email protected]
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+plugins {
+    id("buildlogic.java-library-conventions")
+}
+
+
+dependencies {
+    api(project(":agents"))
+}
diff --git a/...n/agents/regulations/AlwaysPermitted.java → ...poseidon/regulations/AlwaysPermitted.java b/...n/agents/regulations/AlwaysPermitted.java → ...poseidon/regulations/AlwaysPermitted.java
@@ -17,9 +17,10 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import uk.ac.ox.poseidon.agents.behaviours.Action;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 
 public class AlwaysPermitted implements Regulations {
     @Override

diff --git a/...s/regulations/AlwaysPermittedFactory.java → ...n/regulations/AlwaysPermittedFactory.java b/...s/regulations/AlwaysPermittedFactory.java → ...n/regulations/AlwaysPermittedFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import uk.ac.ox.poseidon.core.GlobalScopeFactory;
 import uk.ac.ox.poseidon.core.Simulation;

diff --git a/...tions/FishingLocationLegalityChecker.java → ...tions/FishingLocationLegalityChecker.java b/...tions/FishingLocationLegalityChecker.java → ...tions/FishingLocationLegalityChecker.java
@@ -17,12 +17,13 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.RequiredArgsConstructor;
 import sim.util.Int2D;
 import uk.ac.ox.poseidon.agents.behaviours.Action;
 import uk.ac.ox.poseidon.agents.behaviours.fishing.DummyFishingAction;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 import uk.ac.ox.poseidon.agents.vessels.Vessel;
 import uk.ac.ox.poseidon.geography.distance.Distance;
 import uk.ac.ox.poseidon.geography.paths.GridPathFinder;

diff --git a/...ishingLocationLegalityCheckerFactory.java → ...ishingLocationLegalityCheckerFactory.java b/...ishingLocationLegalityCheckerFactory.java → ...ishingLocationLegalityCheckerFactory.java
@@ -17,12 +17,13 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 import uk.ac.ox.poseidon.agents.vessels.Vessel;
 import uk.ac.ox.poseidon.agents.vessels.VesselScopeFactory;
 import uk.ac.ox.poseidon.core.Factory;

diff --git a/...eidon/agents/regulations/ForbiddenIf.java → .../ox/poseidon/regulations/ForbiddenIf.java b/...eidon/agents/regulations/ForbiddenIf.java → .../ox/poseidon/regulations/ForbiddenIf.java
@@ -17,10 +17,11 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.RequiredArgsConstructor;
 import uk.ac.ox.poseidon.agents.behaviours.Action;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 
 import java.util.function.Predicate;
 

diff --git a/...gents/regulations/ForbiddenIfFactory.java → ...eidon/regulations/ForbiddenIfFactory.java b/...gents/regulations/ForbiddenIfFactory.java → ...eidon/regulations/ForbiddenIfFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...on/agents/regulations/NeverPermitted.java → .../poseidon/regulations/NeverPermitted.java b/...on/agents/regulations/NeverPermitted.java → .../poseidon/regulations/NeverPermitted.java
@@ -17,9 +17,10 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import uk.ac.ox.poseidon.agents.behaviours.Action;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 
 public class NeverPermitted implements Regulations {
     @Override

diff --git a/...ts/regulations/NeverPermittedFactory.java → ...on/regulations/NeverPermittedFactory.java b/...ts/regulations/NeverPermittedFactory.java → ...on/regulations/NeverPermittedFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import uk.ac.ox.poseidon.core.GlobalScopeFactory;
 import uk.ac.ox.poseidon.core.Simulation;

diff --git a/...eidon/agents/regulations/PermittedIf.java → .../ox/poseidon/regulations/PermittedIf.java b/...eidon/agents/regulations/PermittedIf.java → .../ox/poseidon/regulations/PermittedIf.java
@@ -17,10 +17,11 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.RequiredArgsConstructor;
 import uk.ac.ox.poseidon.agents.behaviours.Action;
+import uk.ac.ox.poseidon.agents.regulations.Regulations;
 
 import java.util.function.Predicate;
 

diff --git a/...gents/regulations/PermittedIfFactory.java → ...eidon/regulations/PermittedIfFactory.java b/...gents/regulations/PermittedIfFactory.java → ...eidon/regulations/PermittedIfFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations;
+package uk.ac.ox.poseidon.regulations;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...gulations/predicates/operators/AllOf.java → ...gulations/predicates/operators/AllOf.java b/...gulations/predicates/operators/AllOf.java → ...gulations/predicates/operators/AllOf.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import com.google.common.collect.ImmutableList;
 import lombok.Getter;

diff --git a/...ns/predicates/operators/AllOfFactory.java → ...ns/predicates/operators/AllOfFactory.java b/...ns/predicates/operators/AllOfFactory.java → ...ns/predicates/operators/AllOfFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...gulations/predicates/operators/AnyOf.java → ...gulations/predicates/operators/AnyOf.java b/...gulations/predicates/operators/AnyOf.java → ...gulations/predicates/operators/AnyOf.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import com.google.common.collect.ImmutableList;
 import lombok.Getter;

diff --git a/...ns/predicates/operators/AnyOfFactory.java → ...ns/predicates/operators/AnyOfFactory.java b/...ns/predicates/operators/AnyOfFactory.java → ...ns/predicates/operators/AnyOfFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...regulations/predicates/operators/Not.java → ...regulations/predicates/operators/Not.java b/...regulations/predicates/operators/Not.java → ...regulations/predicates/operators/Not.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import lombok.Getter;
 import lombok.NonNull;

diff --git a/...ions/predicates/operators/NotFactory.java → ...ions/predicates/operators/NotFactory.java b/...ions/predicates/operators/NotFactory.java → ...ions/predicates/operators/NotFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.operators;
+package uk.ac.ox.poseidon.regulations.predicates.operators;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...ons/predicates/temporal/BetweenDates.java → ...ons/predicates/temporal/BetweenDates.java b/...ons/predicates/temporal/BetweenDates.java → ...ons/predicates/temporal/BetweenDates.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.temporal;
+package uk.ac.ox.poseidon.regulations.predicates.temporal;
 
 import lombok.Getter;
 import lombok.NonNull;

diff --git a/...dicates/temporal/BetweenDatesFactory.java → ...dicates/temporal/BetweenDatesFactory.java b/...dicates/temporal/BetweenDatesFactory.java → ...dicates/temporal/BetweenDatesFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.temporal;
+package uk.ac.ox.poseidon.regulations.predicates.temporal;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

diff --git a/...edicates/temporal/BetweenYearlyDates.java → ...edicates/temporal/BetweenYearlyDates.java b/...edicates/temporal/BetweenYearlyDates.java → ...edicates/temporal/BetweenYearlyDates.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.temporal;
+package uk.ac.ox.poseidon.regulations.predicates.temporal;
 
 import lombok.EqualsAndHashCode;
 import lombok.Getter;

diff --git a/...s/temporal/BetweenYearlyDatesFactory.java → ...s/temporal/BetweenYearlyDatesFactory.java b/...s/temporal/BetweenYearlyDatesFactory.java → ...s/temporal/BetweenYearlyDatesFactory.java
@@ -17,7 +17,7 @@
  *
  */
 
-package uk.ac.ox.poseidon.agents.regulations.predicates.temporal;
+package uk.ac.ox.poseidon.regulations.predicates.temporal;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;