Refactor codec and doc format classes for Lucene 9.1

Signed-off-by: Martin Gaievski <[email protected]>

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91Codec.java

@@ -16,6 +16,8 @@
 import org.apache.lucene.codecs.DocValuesFormat;
 import org.apache.lucene.codecs.FilterCodec;
 import org.apache.lucene.codecs.lucene91.Lucene91Codec;
+import org.opensearch.knn.index.codec.KNNDocFormatFacade;
+import org.opensearch.knn.index.codec.KNNDocFormatFactory;
 
 /**
  * Extends the Codec to support a new file format for KNN index
@@ -24,10 +26,8 @@
  */
 public final class KNN91Codec extends FilterCodec {
 
-    private final DocValuesFormat docValuesFormat;
-    private final CompoundFormat compoundFormat;
-
     public static final String KNN_91 = "KNN91Codec";
+    private KNNDocFormatFacade docFormatFacade;
 
     /**
      * No arg constructor that uses Lucene91 as the delegate
@@ -43,17 +43,16 @@ public KNN91Codec() {
      */
     public KNN91Codec(Codec delegate) {
         super(KNN_91, delegate);
-        this.docValuesFormat = new KNN91DocValuesFormat(delegate.docValuesFormat());
-        this.compoundFormat = new KNN91CompoundFormat(delegate.compoundFormat());
+        docFormatFacade = KNNDocFormatFactory.createKNN91DocFormat(delegate);
     }
 
     @Override
     public DocValuesFormat docValuesFormat() {
-        return this.docValuesFormat;
+        return docFormatFacade.docValuesFormat();
     }
 
     @Override
     public CompoundFormat compoundFormat() {
-        return this.compoundFormat;
+        return docFormatFacade.compoundFormat();
     }
 }

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91DocFormat.java

@@ -0,0 +1,37 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+package org.opensearch.knn.index.codec.KNN91Codec;
+
+import org.apache.lucene.codecs.CompoundFormat;
+import org.apache.lucene.codecs.DocValuesFormat;
+import org.opensearch.knn.index.codec.KNNDocFormatFacade;
+
+public class KNN91DocFormat implements KNNDocFormatFacade {
+
+    private final DocValuesFormat docValuesFormat;
+    private final CompoundFormat compoundFormat;
+
+    public KNN91DocFormat(final DocValuesFormat docValuesFormat, final CompoundFormat compoundFormat) {
+        this.docValuesFormat = docValuesFormat;
+        this.compoundFormat = compoundFormat;
+    }
+
+    @Override
+    public DocValuesFormat docValuesFormat() {
+        return docValuesFormat;
+    }
+
+    @Override
+    public CompoundFormat compoundFormat() {
+        return compoundFormat;
+    }
+}

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91BinaryDocValues.java → src/main/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91BinaryDocValues.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import org.apache.lucene.index.BinaryDocValues;
 import org.apache.lucene.index.DocIDMerger;

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91CompoundFormat.java → src/main/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91CompoundFormat.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import org.apache.lucene.codecs.CompoundDirectory;
 import org.apache.lucene.codecs.CompoundFormat;

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91DocValuesConsumer.java → src/main/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91DocValuesConsumer.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import com.google.common.collect.ImmutableMap;
 import org.apache.logging.log4j.LogManager;

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91DocValuesFormat.java → src/main/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91DocValuesFormat.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import org.apache.lucene.codecs.DocValuesConsumer;
 import org.apache.lucene.codecs.DocValuesFormat;

src/main/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91DocValuesReader.java → src/main/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91DocValuesReader.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import org.apache.lucene.codecs.DocValuesProducer;
 import org.apache.lucene.index.BinaryDocValues;

src/main/java/org/opensearch/knn/index/codec/KNNCodecFactory.java

@@ -0,0 +1,22 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+package org.opensearch.knn.index.codec;
+
+import org.apache.lucene.codecs.Codec;
+import org.opensearch.knn.index.codec.KNN91Codec.KNN91Codec;
+
+public class KNNCodecFactory {
+
+    public static Codec createKNN91Codec(Codec userCodec) {
+        return new KNN91Codec(userCodec);
+    }
+}

src/main/java/org/opensearch/knn/index/codec/KNNCodecService.java

@@ -8,7 +8,6 @@
 import org.opensearch.index.codec.CodecServiceConfig;
 import org.apache.lucene.codecs.Codec;
 import org.opensearch.index.codec.CodecService;
-import org.opensearch.knn.index.codec.KNN91Codec.KNN91Codec;
 
 /**
  * KNNCodecService to inject the right KNNCodec version
@@ -27,6 +26,6 @@ public KNNCodecService(CodecServiceConfig codecServiceConfig) {
      */
     @Override
     public Codec codec(String name) {
-        return new KNN91Codec(super.codec(name));
+        return KNNCodecFactory.createKNN91Codec(super.codec(name));
     }
 }

src/main/java/org/opensearch/knn/index/codec/KNNDocFormatFacade.java

@@ -0,0 +1,22 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+package org.opensearch.knn.index.codec;
+
+import org.apache.lucene.codecs.CompoundFormat;
+import org.apache.lucene.codecs.DocValuesFormat;
+
+public interface KNNDocFormatFacade {
+
+    DocValuesFormat docValuesFormat();
+
+    CompoundFormat compoundFormat();
+}

src/main/java/org/opensearch/knn/index/codec/KNNDocFormatFactory.java

@@ -0,0 +1,28 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+package org.opensearch.knn.index.codec;
+
+import org.apache.lucene.codecs.Codec;
+import org.opensearch.knn.index.codec.KNN91Codec.docformat.KNN91CompoundFormat;
+import org.opensearch.knn.index.codec.KNN91Codec.KNN91DocFormat;
+import org.opensearch.knn.index.codec.KNN91Codec.docformat.KNN91DocValuesFormat;
+
+public class KNNDocFormatFactory {
+
+    public static KNNDocFormatFacade createKNN91DocFormat(Codec delegate) {
+        final KNNDocFormatFacade knnDocFormatFacade = new KNN91DocFormat(
+            new KNN91DocValuesFormat(delegate.docValuesFormat()),
+            new KNN91CompoundFormat(delegate.compoundFormat())
+        );
+        return knnDocFormatFacade;
+    }
+}

src/test/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91BinaryDocValuesTests.java → src/test/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91BinaryDocValuesTests.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import com.google.common.collect.ImmutableList;
 import org.apache.lucene.index.BinaryDocValues;

src/test/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91CompoundFormatTests.java → src/test/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91CompoundFormatTests.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import org.apache.lucene.codecs.Codec;
 import org.apache.lucene.codecs.CompoundDirectory;
@@ -16,6 +22,7 @@
 import org.junit.BeforeClass;
 import org.opensearch.common.util.set.Sets;
 import org.opensearch.knn.KNNTestCase;
+import org.opensearch.knn.index.codec.KNN91Codec.KNN91Codec;
 import org.opensearch.knn.index.codec.KNNCodecTestUtil;
 import org.opensearch.knn.index.util.KNNEngine;
 

src/test/java/org/opensearch/knn/index/codec/KNN91Codec/KNN91DocValuesConsumerTests.java → src/test/java/org/opensearch/knn/index/codec/KNN91Codec/docformat/KNN91DocValuesConsumerTests.java

@@ -1,9 +1,15 @@
 /*
- * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
  */
 
-package org.opensearch.knn.index.codec.KNN91Codec;
+package org.opensearch.knn.index.codec.KNN91Codec.docformat;
 
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;