Add more java doc.

Signed-off-by: Bo Zhang <[email protected]>

Author: bzhangam

src/main/java/org/opensearch/neuralsearch/constants/FieldConstants.java

@@ -0,0 +1,15 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.opensearch.neuralsearch.constants;
+
+/**
+ * Constants related to the index mapping.
+ */
+public class MappingConstants {
+    /**
+     * Name for the field type. In index mapping we use this key to define the field type.
+     */
+    public static final String TYPE = "type";
+}

src/main/java/org/opensearch/neuralsearch/constants/MappingConstants.java

@@ -4,9 +4,30 @@
  */
 package org.opensearch.neuralsearch.constants;
 
+/**
+ * Constants for semantic field
+ */
 public class SemanticFieldConstants {
+    /**
+     * Name of the model id parameter. We use this key to define the id of the ML model that we will use for the
+     * semantic field.
+     */
     public static final String MODEL_ID = "model_id";
+
+    /**
+     * Name of the search model id parameter. We use this key to define the id of the ML model that we will use to
+     * inference the query text during the search. If this parameter is not defined we will use the model_id instead.
+     */
     public static final String SEARCH_MODEL_ID = "search_model_id";
+
+    /**
+     * Name of the raw field type parameter. We use this key to define the field type for the raw data. It will control
+     * how to store and query the raw data.
+     */
     public static final String RAW_FIELD_TYPE = "raw_field_type";
+
+    /**
+     * Name of the raw field type parameter. We use this key to define a custom field name for the semantic info.
+     */
     public static final String SEMANTIC_INFO_FIELD_NAME = "semantic_info_field_name";
 }

src/main/java/org/opensearch/neuralsearch/constants/SemanticFieldConstants.java

@@ -18,13 +18,14 @@
 import org.opensearch.index.mapper.TextFieldMapper;
 import org.opensearch.index.mapper.TokenCountFieldMapper;
 import org.opensearch.index.mapper.WildcardFieldMapper;
-import org.opensearch.neuralsearch.constants.FieldConstants;
-import org.opensearch.neuralsearch.mapper.semanticFieldTypes.SemanticFieldTypeFactory;
+import org.opensearch.neuralsearch.constants.MappingConstants;
+import org.opensearch.neuralsearch.mapper.semanticfieldtypes.SemanticFieldTypeFactory;
 
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.MODEL_ID;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.RAW_FIELD_TYPE;
@@ -161,7 +162,7 @@ public SemanticFieldMapper build(BuilderContext context) {
 
     public static class TypeParser implements Mapper.TypeParser {
 
-        private final static List<String> SUPPORTED_RAW_FIELD_TYPE = List.of(
+        private final static Set<String> SUPPORTED_RAW_FIELD_TYPE = Set.of(
             TextFieldMapper.CONTENT_TYPE,
             KeywordFieldMapper.CONTENT_TYPE,
             MatchOnlyTextFieldMapper.CONTENT_TYPE,
@@ -215,15 +216,15 @@ private Map<String, Object> extractSemanticConfig(Map<String, Object> node, List
                     node.remove(parameter.name);
                 }
             }
-            semanticConfig.put(FieldConstants.TYPE, SemanticFieldMapper.CONTENT_TYPE);
-            node.put(FieldConstants.TYPE, rawFieldType);
+            semanticConfig.put(MappingConstants.TYPE, SemanticFieldMapper.CONTENT_TYPE);
+            node.put(MappingConstants.TYPE, rawFieldType);
             return semanticConfig;
         }
     }
 
     @Override
     protected void doXContentBody(XContentBuilder builder, boolean includeDefaults, Params params) throws IOException {
-        builder.field(FieldConstants.TYPE, contentType());
+        builder.field(MappingConstants.TYPE, contentType());
 
         // semantic parameters
         final List<Parameter<?>> parameters = getMergeBuilder().getParameters();

src/main/java/org/opensearch/neuralsearch/mapper/SemanticFieldMapper.java

@@ -2,7 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.opensearch.neuralsearch.mapper.semanticFieldTypes;
+package org.opensearch.neuralsearch.mapper.semanticfieldtypes;
 
 import lombok.Getter;
 import lombok.NonNull;
@@ -19,6 +19,9 @@
 import java.time.ZoneId;
 import java.util.function.Supplier;
 
+/**
+ * A semantic field type that delegate the work to a mapped field type.
+ */
 public class SemanticFieldType extends MappedFieldType {
     @Getter
     private SemanticFieldTypeParameters semanticFieldTypeParameters;

src/main/java/org/opensearch/neuralsearch/mapper/semanticFieldTypes/SemanticFieldType.java renamed to src/main/java/org/opensearch/neuralsearch/mapper/semanticfieldtypes/SemanticFieldType.java

@@ -2,7 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.opensearch.neuralsearch.mapper.semanticFieldTypes;
+package org.opensearch.neuralsearch.mapper.semanticfieldtypes;
 
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
@@ -18,17 +18,27 @@
 import org.opensearch.index.mapper.WildcardFieldMapper;
 import org.opensearch.neuralsearch.mapper.SemanticFieldMapper;
 
-import java.util.List;
+import java.util.Set;
 
+/**
+ * A factory to create the semantic field type based on the raw field type.
+ */
 @NoArgsConstructor
 public class SemanticFieldTypeFactory {
-    private static final List<String> STRING_FIELD_TYPES = List.of(
+    private static final Set<String> STRING_FIELD_TYPES = Set.of(
         TextFieldMapper.CONTENT_TYPE,
         MatchOnlyTextFieldMapper.CONTENT_TYPE,
         KeywordFieldMapper.CONTENT_TYPE,
         WildcardFieldMapper.CONTENT_TYPE
     );
 
+    /**
+     * Create the semantic field type based on the raw field type.
+     * @param delegateMapper delegate field mapper
+     * @param rawFieldType field type for the raw data
+     * @param builder semantic field mapper builder
+     * @return semantic field type
+     */
     public MappedFieldType createSemanticFieldType(
         @NonNull final ParametrizedFieldMapper delegateMapper,
         @NonNull final String rawFieldType,

src/main/java/org/opensearch/neuralsearch/mapper/semanticFieldTypes/SemanticFieldTypeFactory.java renamed to src/main/java/org/opensearch/neuralsearch/mapper/semanticfieldtypes/SemanticFieldTypeFactory.java

@@ -2,19 +2,22 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.opensearch.neuralsearch.mapper.semanticFieldTypes;
+package org.opensearch.neuralsearch.mapper.semanticfieldtypes;
 
 import lombok.Getter;
 import org.opensearch.neuralsearch.mapper.SemanticFieldMapper;
 
+/**
+ * An object to hold all the parameters we can have in a semantic field type.
+ */
 @Getter
 public class SemanticFieldTypeParameters {
     private final String modelId;
     private final String searchModelId;
     private final String semanticInfoFieldName;
     private final String rawFieldType;
 
-    SemanticFieldTypeParameters(SemanticFieldMapper.Builder builder) {
+    public SemanticFieldTypeParameters(SemanticFieldMapper.Builder builder) {
         modelId = builder.getModelId().getValue();
         searchModelId = builder.getSearchModelId().getValue();
         semanticInfoFieldName = builder.getSemanticInfoFieldName().getValue();

src/main/java/org/opensearch/neuralsearch/mapper/semanticFieldTypes/SemanticFieldTypeParameters.java renamed to src/main/java/org/opensearch/neuralsearch/mapper/semanticfieldtypes/SemanticFieldTypeParameters.java

@@ -2,7 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.opensearch.neuralsearch.mapper.semanticFieldTypes;
+package org.opensearch.neuralsearch.mapper.semanticfieldtypes;
 
 import lombok.Getter;
 import lombok.NonNull;
@@ -12,6 +12,9 @@
 import org.opensearch.neuralsearch.mapper.SemanticFieldMapper;
 import org.opensearch.search.lookup.SearchLookup;
 
+/**
+ * A semantic field type that delegate the work to a number field type.
+ */
 public class SemanticNumberFieldType extends NumberFieldMapper.NumberFieldType {
     @Getter
     private SemanticFieldTypeParameters semanticFieldTypeParameters;

src/main/java/org/opensearch/neuralsearch/mapper/semanticFieldTypes/SemanticNumberFieldType.java renamed to src/main/java/org/opensearch/neuralsearch/mapper/semanticfieldtypes/SemanticNumberFieldType.java

@@ -2,7 +2,7 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.opensearch.neuralsearch.mapper.semanticFieldTypes;
+package org.opensearch.neuralsearch.mapper.semanticfieldtypes;
 
 import lombok.Getter;
 import lombok.NonNull;
@@ -27,6 +27,9 @@
 import java.util.List;
 import java.util.function.Supplier;
 
+/**
+ * A semantic field type that delegate the work to a string field type.
+ */
 public class SemanticStringFieldType extends StringFieldType {
     @Getter
     private SemanticFieldTypeParameters semanticFieldTypeParameters;

src/main/java/org/opensearch/neuralsearch/mapper/semanticFieldTypes/SemanticStringFieldType.java renamed to src/main/java/org/opensearch/neuralsearch/mapper/semanticfieldtypes/SemanticStringFieldType.java

@@ -23,7 +23,7 @@
 import static org.mockito.Mockito.when;
 import static org.opensearch.Version.CURRENT;
 import static org.opensearch.knn.index.KNNSettings.KNN_INDEX;
-import static org.opensearch.neuralsearch.constants.FieldConstants.TYPE;
+import static org.opensearch.neuralsearch.constants.MappingConstants.TYPE;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.MODEL_ID;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.RAW_FIELD_TYPE;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.SEARCH_MODEL_ID;

src/test/java/org/opensearch/neuralsearch/mapper/SemanticFieldMapperTestUtil.java

@@ -18,7 +18,7 @@
 import org.opensearch.index.mapper.ParseContext;
 import org.opensearch.index.mapper.TextFieldMapper;
 import org.opensearch.index.mapper.WildcardFieldMapper;
-import org.opensearch.neuralsearch.mapper.semanticFieldTypes.SemanticStringFieldType;
+import org.opensearch.neuralsearch.mapper.semanticfieldtypes.SemanticStringFieldType;
 import org.opensearch.test.OpenSearchTestCase;
 
 import java.io.IOException;
@@ -32,7 +32,7 @@
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
-import static org.opensearch.neuralsearch.constants.FieldConstants.TYPE;
+import static org.opensearch.neuralsearch.constants.MappingConstants.TYPE;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.MODEL_ID;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.RAW_FIELD_TYPE;
 import static org.opensearch.neuralsearch.constants.SemanticFieldConstants.SEARCH_MODEL_ID;
@@ -138,9 +138,8 @@ public void testTypeParser_parse_whenUnsupportedRawFieldType_thenException() {
             IllegalArgumentException.class,
             () -> TYPE_PARSER.parse(SemanticFieldMapperTestUtil.fieldName, node, parserContext)
         );
-        final String expectedError = "raw_field_type: [unsupported] is not supported. It should be one of "
-            + "[text,keyword,match_only_text,wildcard,token_count,binary]";
-        assertEquals(expectedError, exception.getMessage());
+        final String expectedError = "raw_field_type: [unsupported] is not supported. It should be one of";
+        assertTrue(exception.getMessage().contains(expectedError));
     }
 
     private void assertBuilderParseParametersSuccessfully(