Merge pull request #867 from VolodymyrLinuxovich/operation-type-855

Add OperationType to identify operations in ProgramValidator

Author: sampottinger

engine/src/main/java/org/kigalisim/lang/operation/ChangeOperation.java

@@ -79,4 +79,10 @@ public void execute(PushDownMachine machine) {
   public String getStream() {
     return stream;
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationType getOperationType() {
+    return OperationType.CHANGE;
+  }
 }

engine/src/main/java/org/kigalisim/lang/operation/Operation.java

@@ -21,4 +21,13 @@ public interface Operation {
    */
   void execute(PushDownMachine machine);
 
+  /**
+   * Get the kind of this operation.
+   *
+   * @return The type of this operation or OTHER if not specified.
+   */
+  default OperationType getOperationType() {
+    return OperationType.OTHER;
+  }
+
 }

engine/src/main/java/org/kigalisim/lang/operation/OperationType.java

@@ -0,0 +1,26 @@
+/**
+ * Enum describing the kind of an operation.
+ *
+ * <p>This enum lets code which inspects a parsed program, like validators, identify an
+ * operation without checking its concrete class.</p>
+ *
+ * @license BSD-3-Clause
+ */
+
+package org.kigalisim.lang.operation;
+
+/**
+ * Enum describing the kind of an operation.
+ */
+public enum OperationType {
+  /** Retirement following a Weibull survival curve. */
+  RETIRE_WEIBULL,
+  /** Retirement of the cohort at an exact age. */
+  RETIRE_EXACT,
+  /** Set of a stream value. */
+  SET,
+  /** Change of a stream value. */
+  CHANGE,
+  /** Any other operation. */
+  OTHER
+}

engine/src/main/java/org/kigalisim/lang/operation/RetireExactOperation.java

@@ -87,6 +87,12 @@ public boolean getAssumingNew() {
     return assumingNew;
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public OperationType getOperationType() {
+    return OperationType.RETIRE_EXACT;
+  }
+
   /**
    * Execute the exact retire operation on the given push-down machine.
    *

engine/src/main/java/org/kigalisim/lang/operation/RetireWeibullOperation.java

@@ -81,6 +81,12 @@ public boolean getAssumingNew() {
     return assumingNew;
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public OperationType getOperationType() {
+    return OperationType.RETIRE_WEIBULL;
+  }
+
   /**
    * Execute the Weibull retire operation on the given push-down machine.
    *

engine/src/main/java/org/kigalisim/lang/operation/SetOperation.java

@@ -80,4 +80,10 @@ public void execute(PushDownMachine machine) {
   public String getStream() {
     return stream;
   }
+
+  /** {@inheritDoc} */
+  @Override
+  public OperationType getOperationType() {
+    return OperationType.SET;
+  }
 }

engine/src/main/java/org/kigalisim/lang/program/ProgramValidator.java

@@ -12,6 +12,7 @@
 import java.util.Map;
 import org.kigalisim.lang.operation.ChangeOperation;
 import org.kigalisim.lang.operation.Operation;
+import org.kigalisim.lang.operation.OperationType;
 import org.kigalisim.lang.operation.RetireExactOperation;
 import org.kigalisim.lang.operation.RetireWeibullOperation;
 import org.kigalisim.lang.operation.SetOperation;
@@ -133,16 +134,21 @@ private static void validateOperations(Iterable<Operation> operations) {
     boolean setsPriorEquipment = false;
 
     for (Operation operation : operations) {
-      if (operation instanceof RetireWeibullOperation weibull && !weibull.getAssumingNew()) {
+      OperationType operationType = operation.getOperationType();
+      if (operationType == OperationType.RETIRE_WEIBULL
+          && !((RetireWeibullOperation) operation).getAssumingNew()) {
         hasWeibullWithoutAssumingNew = true;
       }
-      if (operation instanceof RetireExactOperation exact && !exact.getAssumingNew()) {
+      if (operationType == OperationType.RETIRE_EXACT
+          && !((RetireExactOperation) operation).getAssumingNew()) {
         hasExactRetireWithoutAssumingNew = true;
       }
-      if (operation instanceof SetOperation set && "priorEquipment".equals(set.getStream())) {
+      if (operationType == OperationType.SET
+          && "priorEquipment".equals(((SetOperation) operation).getStream())) {
         setsPriorEquipment = true;
       }
-      if (operation instanceof ChangeOperation change && "priorEquipment".equals(change.getStream())) {
+      if (operationType == OperationType.CHANGE
+          && "priorEquipment".equals(((ChangeOperation) operation).getStream())) {
         setsPriorEquipment = true;
       }
     }

engine/src/test/java/org/kigalisim/lang/operation/OperationTypeTest.java

@@ -0,0 +1,67 @@
+/**
+ * Unit tests for the OperationType reported by operations.
+ *
+ * @license BSD-3-Clause
+ */
+
+package org.kigalisim.lang.operation;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.math.BigDecimal;
+import org.junit.jupiter.api.Test;
+import org.kigalisim.engine.number.EngineNumber;
+
+/**
+ * Tests for the OperationType reported by operations.
+ */
+public class OperationTypeTest {
+
+  private final Operation valueOperation = new PreCalculatedOperation(
+      new EngineNumber(BigDecimal.ONE, "units")
+  );
+
+  /**
+   * Test that a Weibull retire operation reports RETIRE_WEIBULL.
+   */
+  @Test
+  public void testRetireWeibullType() {
+    Operation operation = new RetireWeibullOperation(BigDecimal.TEN, false, false);
+    assertEquals(OperationType.RETIRE_WEIBULL, operation.getOperationType());
+  }
+
+  /**
+   * Test that an exact retire operation reports RETIRE_EXACT.
+   */
+  @Test
+  public void testRetireExactType() {
+    Operation operation = new RetireExactOperation(valueOperation, 5, false, false);
+    assertEquals(OperationType.RETIRE_EXACT, operation.getOperationType());
+  }
+
+  /**
+   * Test that a set operation reports SET.
+   */
+  @Test
+  public void testSetType() {
+    Operation operation = new SetOperation("priorEquipment", valueOperation);
+    assertEquals(OperationType.SET, operation.getOperationType());
+  }
+
+  /**
+   * Test that a change operation reports CHANGE.
+   */
+  @Test
+  public void testChangeType() {
+    Operation operation = new ChangeOperation("priorEquipment", valueOperation);
+    assertEquals(OperationType.CHANGE, operation.getOperationType());
+  }
+
+  /**
+   * Test that operations without a specific type report OTHER.
+   */
+  @Test
+  public void testDefaultType() {
+    assertEquals(OperationType.OTHER, valueOperation.getOperationType());
+  }
+}