Cleaning up core

Signed-off-by: Peter Nied <[email protected]>

RFS/src/main/java/com/rfs/transformers/TransformFunctions.java

@@ -94,10 +94,10 @@ public static  void removeIntermediateIndexSettingsLevel(ObjectNode root) {
     }
 
     /**
+     * If allocation awareness is enabled, we need to ensure that the number of copies of our data matches the dimensionality.
      * As a specific example, if you spin up a cluster spread across 3 availability zones and your awareness attribute is "zone",
      * then the dimensionality would be 3.  This means you need to ensure the number of total copies is a multiple of 3, with
-     * the minimum number of     * If allocation awareness is enabled, we need to ensure that the number of copies of our data matches the dimensionality.
- replicas being 2.
+     * the minimum number of replicas being 2.
      */
     public static void fixReplicasForDimensionality(ObjectNode root, int dimensionality) {
         if (root.has("settings")) {

RFS/src/main/java/com/rfs/version_es_6_8/GlobalMetadataData_ES_6_8.java

@@ -3,7 +3,7 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.rfs.models.GlobalMetadata;
 
-public class GlobalMetadataData_ES_6_8 implements com.rfs.models.GlobalMetadata {
+public class GlobalMetadataData_ES_6_8 implements GlobalMetadata {
     private final ObjectNode root;
 
     public GlobalMetadataData_ES_6_8(ObjectNode root) {

RFS/src/main/java/com/rfs/version_es_6_8/GlobalMetadataFactory_ES_6_8.java

@@ -6,7 +6,7 @@
 import com.rfs.common.SnapshotRepo;
 import com.rfs.models.GlobalMetadata;
 
-public class GlobalMetadataFactory_ES_6_8 implements com.rfs.models.GlobalMetadata.Factory{
+public class GlobalMetadataFactory_ES_6_8 implements GlobalMetadata.Factory{
     private final SnapshotRepo.Provider repoDataProvider;
 
     public GlobalMetadataFactory_ES_6_8(SnapshotRepo.Provider repoDataProvider) {

RFS/src/main/java/com/rfs/version_es_6_8/IndexMetadataData_ES_6_8.java

@@ -5,7 +5,7 @@
 import com.rfs.models.IndexMetadata;
 import com.rfs.transformers.TransformFunctions;
 
-public class IndexMetadataData_ES_6_8 implements com.rfs.models.IndexMetadata {
+public class IndexMetadataData_ES_6_8 implements IndexMetadata {
     private ObjectNode root;
     private ObjectNode mappings;
     private ObjectNode settings;

RFS/src/main/java/com/rfs/version_es_6_8/IndexMetadataFactory_ES_6_8.java

@@ -6,7 +6,7 @@
 import com.rfs.common.SnapshotRepo;
 import com.rfs.models.IndexMetadata;
 
-public class IndexMetadataFactory_ES_6_8 implements com.rfs.models.IndexMetadata.Factory {
+public class IndexMetadataFactory_ES_6_8 implements IndexMetadata.Factory {
     private final SnapshotRepo.Provider repoDataProvider;
 
     public IndexMetadataFactory_ES_6_8(SnapshotRepo.Provider repoDataProvider) {

RFS/src/main/java/com/rfs/version_es_6_8/SnapshotMetadataFactory_ES_6_8.java

@@ -6,7 +6,7 @@
 import com.fasterxml.jackson.dataformat.smile.SmileFactory;
 import com.rfs.models.SnapshotMetadata;
 
-public class SnapshotMetadataFactory_ES_6_8 implements com.rfs.models.SnapshotMetadata.Factory {
+public class SnapshotMetadataFactory_ES_6_8 implements SnapshotMetadata.Factory {
 
     /**
      * A version of the Elasticsearch approach simplified by assuming JSON; see here [1] for more details.

RFS/src/main/java/com/rfs/version_es_7_10/GlobalMetadataData_ES_7_10.java

@@ -1,8 +1,9 @@
 package com.rfs.version_es_7_10;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.rfs.models.GlobalMetadata;
 
-public class GlobalMetadataData_ES_7_10 implements com.rfs.models.GlobalMetadata {
+public class GlobalMetadataData_ES_7_10 implements GlobalMetadata {
     private final ObjectNode root;
 
     public GlobalMetadataData_ES_7_10(ObjectNode root) {

RFS/src/main/java/com/rfs/version_es_7_10/GlobalMetadataFactory_ES_7_10.java

@@ -6,7 +6,7 @@
 import com.rfs.common.SnapshotRepo;
 import com.rfs.models.GlobalMetadata;
 
-public class GlobalMetadataFactory_ES_7_10 implements com.rfs.models.GlobalMetadata.Factory{
+public class GlobalMetadataFactory_ES_7_10 implements GlobalMetadata.Factory{
     private final SnapshotRepo.Provider repoDataProvider;
 
     public GlobalMetadataFactory_ES_7_10(SnapshotRepo.Provider repoDataProvider) {

RFS/src/main/java/com/rfs/version_es_7_10/IndexMetadataData_ES_7_10.java

@@ -5,7 +5,7 @@
 import com.rfs.models.IndexMetadata;
 import com.rfs.transformers.TransformFunctions;
 
-public class IndexMetadataData_ES_7_10 implements com.rfs.models.IndexMetadata {
+public class IndexMetadataData_ES_7_10 implements IndexMetadata {
     private ObjectNode root;
     private ObjectNode mappings;
     private ObjectNode settings;

RFS/src/main/java/com/rfs/version_es_7_10/IndexMetadataFactory_ES_7_10.java

@@ -6,7 +6,7 @@
 import com.rfs.common.SnapshotRepo;
 import com.rfs.models.IndexMetadata;
 
-public class IndexMetadataFactory_ES_7_10 implements com.rfs.models.IndexMetadata.Factory {
+public class IndexMetadataFactory_ES_7_10 implements IndexMetadata.Factory {
     private final SnapshotRepo.Provider repoDataProvider;
 
     public IndexMetadataFactory_ES_7_10(SnapshotRepo.Provider repoDataProvider) {

RFS/src/main/java/com/rfs/version_es_7_10/SnapshotMetadataFactory_ES_7_10.java

@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.dataformat.smile.SmileFactory;
 import com.rfs.models.SnapshotMetadata;
 
-public class SnapshotMetadataFactory_ES_7_10 implements com.rfs.models.SnapshotMetadata.Factory {
+public class SnapshotMetadataFactory_ES_7_10 implements SnapshotMetadata.Factory {
 
     /**
      * A version of the Elasticsearch approach simplified by assuming JSON; see here [1] for more details.

coreUtilities/src/main/java/org/opensearch/migrations/transformation/CanApplyResult.java

@@ -1,7 +1,26 @@
 package org.opensearch.migrations.transformation;
 
-public enum CanApplyResult {
-    YES,
-    NO,
-    UNSUPPORTED;
-}
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * The result after checking if a transformer can be applied to an entity
+ */
+public abstract class CanApplyResult {
+    public final static CanApplyResult YES = new Yes();
+    public final static CanApplyResult NO = new No();
+
+
+    public static final class Yes extends CanApplyResult {
+    }
+
+    public static final class No extends CanApplyResult {
+    }
+
+    /** If the transformation should apply but there is an issue that would prevent it from being applied corrrectly, return a reason */
+    @RequiredArgsConstructor
+    @Getter
+    public static final class Unsupported extends CanApplyResult {
+        private final String reason;
+    }
+}

coreUtilities/src/main/java/org/opensearch/migrations/transformation/TransformationRule.java

@@ -6,8 +6,17 @@
  * Describes how to an entity is transformed from one version to another.
  */
 public interface TransformationRule<T extends Entity> {
-    VersionRange supportedSourceVersionRange();
-    VersionRange supportedTargetVersionRange();
+    /**
+     * Given an entity can a transformation be run on it
+     * 
+     * MUST ALWAYS BE READ ONLY
+     */
     CanApplyResult canApply(T entity);
+
+    /**
+     * Apply a transformation on the entity
+     * @param entity The entity to be transformed in place
+     * @return true if the entity was updated, or false if no changse were made
+     */
     boolean applyTransformation(T entity);
 }