Added TextFamilyFieldType + Builder

Author: Kubik42

modules/mapper-extras/src/main/java/org/elasticsearch/index/mapper/extras/MatchOnlyTextFieldMapper.java

@@ -54,7 +54,8 @@
 import org.elasticsearch.index.mapper.SourceFieldMapper;
 import org.elasticsearch.index.mapper.SourceLoader;
 import org.elasticsearch.index.mapper.SourceValueFetcher;
-import org.elasticsearch.index.mapper.StringFieldType;
+import org.elasticsearch.index.mapper.TextFamilyFieldMapper;
+import org.elasticsearch.index.mapper.TextFamilyFieldType;
 import org.elasticsearch.index.mapper.TextFieldMapper;
 import org.elasticsearch.index.mapper.TextFieldMapper.TextFieldType;
 import org.elasticsearch.index.mapper.TextParams;
@@ -100,9 +101,7 @@ public static class Defaults {
 
     }
 
-    public static class Builder extends FieldMapper.Builder {
-
-        private final IndexVersion indexCreatedVersion;
+    public static class Builder extends TextFamilyFieldMapper.Builder {
 
         private final Parameter<Map<String, String>> meta = Parameter.metaParam();
 
@@ -117,8 +116,7 @@ public Builder(
             boolean isSyntheticSourceEnabled,
             boolean isWithinMultiField
         ) {
-            super(name, isSyntheticSourceEnabled, isWithinMultiField);
-            this.indexCreatedVersion = indexCreatedVersion;
+            super(name, indexCreatedVersion, isSyntheticSourceEnabled, isWithinMultiField);
             this.analyzers = new TextParams.Analyzers(
                 indexAnalyzers,
                 m -> ((MatchOnlyTextFieldMapper) m).indexAnalyzer,
@@ -187,7 +185,7 @@ private static boolean isSyntheticSourceStoredFieldInBinaryFormat(IndexVersion i
         )
     );
 
-    public static class MatchOnlyTextFieldType extends StringFieldType {
+    public static class MatchOnlyTextFieldType extends TextFamilyFieldType {
 
         private final Analyzer indexAnalyzer;
         private final TextFieldType textFieldType;
@@ -586,7 +584,7 @@ protected BytesRef toBytesRef(Object v) {
 
         @Override
         public BlockLoader blockLoader(BlockLoaderContext blContext) {
-            if (textFieldType.isSyntheticSourceEnabled()) {
+            if (isSyntheticSourceEnabled()) {
                 final String fieldName = syntheticSourceFallbackFieldName();
                 if (storedFieldInBinaryFormat) {
                     return new BlockStoredFieldsReader.BytesFromBytesRefsBlockLoader(fieldName);
@@ -605,7 +603,7 @@ public IndexFieldData.Builder fielddataBuilder(FieldDataContext fieldDataContext
             if (fieldDataContext.fielddataOperation() != FielddataOperation.SCRIPT) {
                 throw new IllegalArgumentException(CONTENT_TYPE + " fields do not support sorting and aggregations");
             }
-            if (textFieldType.isSyntheticSourceEnabled()) {
+            if (isSyntheticSourceEnabled()) {
                 return (cache, breaker) -> new StoredFieldSortedBinaryIndexFieldData(
                     syntheticSourceFallbackFieldName(),
                     CoreValuesSourceType.KEYWORD,
@@ -652,7 +650,7 @@ private MatchOnlyTextFieldMapper(
         assert mappedFieldType.hasDocValues() == false;
 
         this.fieldType = freezeAndDeduplicateFieldType(fieldType);
-        this.indexCreatedVersion = builder.indexCreatedVersion;
+        this.indexCreatedVersion = builder.indexCreatedVersion();
         this.indexAnalyzers = builder.analyzers.indexAnalyzers;
         this.indexAnalyzer = builder.analyzers.getIndexAnalyzer();
         this.positionIncrementGap = builder.analyzers.positionIncrementGap.getValue();

plugins/mapper-annotated-text/src/main/java/org/elasticsearch/index/mapper/annotatedtext/AnnotatedTextFieldMapper.java

@@ -35,6 +35,7 @@
 import org.elasticsearch.index.mapper.SourceFieldMapper;
 import org.elasticsearch.index.mapper.SourceLoader;
 import org.elasticsearch.index.mapper.StringStoredFieldFieldLoader;
+import org.elasticsearch.index.mapper.TextFamilyFieldMapper;
 import org.elasticsearch.index.mapper.TextFieldMapper;
 import org.elasticsearch.index.mapper.TextParams;
 import org.elasticsearch.index.mapper.TextSearchInfo;
@@ -81,7 +82,7 @@ private static NamedAnalyzer wrapAnalyzer(NamedAnalyzer in) {
         );
     }
 
-    public static class Builder extends FieldMapper.Builder {
+    public static class Builder extends TextFamilyFieldMapper.Builder {
 
         final Parameter<SimilarityProvider> similarity = TextParams.similarity(m -> builder(m).similarity.getValue());
         final Parameter<String> indexOptions = TextParams.textIndexOptions(m -> builder(m).indexOptions.getValue());
@@ -90,7 +91,6 @@ public static class Builder extends FieldMapper.Builder {
 
         private final Parameter<Map<String, String>> meta = Parameter.metaParam();
 
-        private final IndexVersion indexCreatedVersion;
         private final TextParams.Analyzers analyzers;
         private final Parameter<Boolean> store;
 
@@ -101,8 +101,7 @@ public Builder(
             boolean isSyntheticSourceEnabled,
             boolean isWithinMultiField
         ) {
-            super(name, isSyntheticSourceEnabled, isWithinMultiField);
-            this.indexCreatedVersion = indexCreatedVersion;
+            super(name, indexCreatedVersion, isSyntheticSourceEnabled, isWithinMultiField);
             this.analyzers = new TextParams.Analyzers(
                 indexAnalyzers,
                 m -> builder(m).analyzers.getIndexAnalyzer(),
@@ -113,7 +112,7 @@ public Builder(
         }
 
         private boolean storeDefault() {
-            if (TextFieldMapper.keywordMultiFieldsNotStoredWhenIgnored_indexVersionCheck(indexCreatedVersion)) {
+            if (TextFieldMapper.keywordMultiFieldsNotStoredWhenIgnored_indexVersionCheck(indexCreatedVersion())) {
                 return false;
             }
             return isSyntheticSourceEnabled() && multiFieldsBuilder.hasSyntheticSourceCompatibleKeywordField() == false;
@@ -544,7 +543,7 @@ protected AnnotatedTextFieldMapper(
         this.fieldType = freezeAndDeduplicateFieldType(fieldType);
         this.builder = builder;
         this.indexAnalyzer = wrapAnalyzer(builder.analyzers.getIndexAnalyzer());
-        this.indexCreatedVersion = builder.indexCreatedVersion;
+        this.indexCreatedVersion = builder.indexCreatedVersion();
     }
 
     @Override
@@ -603,7 +602,7 @@ protected String contentType() {
     public FieldMapper.Builder getMergeBuilder() {
         return new Builder(
             leafName(),
-            builder.indexCreatedVersion,
+            builder.indexCreatedVersion(),
             builder.analyzers.indexAnalyzers,
             fieldType().isSyntheticSourceEnabled(),
             fieldType().isWithinMultiField()

server/src/main/java/org/elasticsearch/index/mapper/FieldMapper.java

@@ -149,14 +149,6 @@ public Optional<SourceKeepMode> sourceKeepMode() {
         return builderParams.sourceKeepMode;
     }
 
-    public boolean isSyntheticSourceEnabled() {
-        return fieldType().isSyntheticSourceEnabled();
-    }
-
-    public boolean isWithinMultiField() {
-        return fieldType().isWithinMultiField();
-    }
-
     /**
      * Will this field ignore malformed values for this field and accept the
      * document ({@code true}) or will it reject documents with malformed
@@ -1416,22 +1408,11 @@ public abstract static class Builder extends Mapper.Builder implements ToXConten
         protected boolean hasScript = false;
         protected OnScriptError onScriptError = null;
 
-        // we're using Boolean here instead of boolean by design - to throw a NPE when users attempt to use these fields without
-        // initializing them first
-        private final Boolean isSyntheticSourceEnabled;
-        private final Boolean isWithinMultiField;
-
         /**
          * Creates a new Builder with a field name
          */
         protected Builder(String name) {
-            this(name, null, null);
-        }
-
-        protected Builder(String name, Boolean isSyntheticSourceEnabled, Boolean isWithinMultiField) {
             super(name);
-            this.isSyntheticSourceEnabled = isSyntheticSourceEnabled;
-            this.isWithinMultiField = isWithinMultiField;
         }
 
         /**
@@ -1447,16 +1428,6 @@ public Builder init(FieldMapper initializer) {
             return this;
         }
 
-        public boolean isSyntheticSourceEnabled() {
-            Objects.requireNonNull(isSyntheticSourceEnabled, "You're attempting to use isSyntheticSourceEnabled without setting it first!");
-            return isSyntheticSourceEnabled;
-        }
-
-        public boolean isWithinMultiField() {
-            Objects.requireNonNull(isWithinMultiField, "You're attempting to use isWithinMultiField without setting it first!");
-            return isWithinMultiField;
-        }
-
         public Builder addMultiField(FieldMapper.Builder builder) {
             this.multiFieldsBuilder.add(builder);
             return this;

server/src/main/java/org/elasticsearch/index/mapper/KeywordFieldMapper.java

@@ -546,7 +546,7 @@ private static boolean indexSortConfigByHostName(final IndexSortConfig indexSort
 
     public static final TypeParser PARSER = createTypeParserWithLegacySupport(Builder::new);
 
-    public static final class KeywordFieldType extends StringFieldType {
+    public static final class KeywordFieldType extends TextFamilyFieldType {
 
         private final int ignoreAbove;
         private final String nullValue;

server/src/main/java/org/elasticsearch/index/mapper/MappedFieldType.java

@@ -72,31 +72,13 @@ public abstract class MappedFieldType {
     private final TextSearchInfo textSearchInfo;
     private final Map<String, String> meta;
 
-    // we're using Boolean here instead of boolean by design - to throw a NPE when users attempt to use these fields without
-    // initializing them first
-    private final Boolean isSyntheticSourceEnabled;
-    private final Boolean isWithinMultiField;
-
     public MappedFieldType(
         String name,
         boolean isIndexed,
         boolean isStored,
         boolean hasDocValues,
         TextSearchInfo textSearchInfo,
         Map<String, String> meta
-    ) {
-        this(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, null, null);
-    }
-
-    public MappedFieldType(
-        String name,
-        boolean isIndexed,
-        boolean isStored,
-        boolean hasDocValues,
-        TextSearchInfo textSearchInfo,
-        Map<String, String> meta,
-        Boolean isSyntheticSourceEnabled,
-        Boolean isWithinMultiField
     ) {
         this.name = Mapper.internFieldName(name);
         this.isIndexed = isIndexed;
@@ -106,26 +88,6 @@ public MappedFieldType(
         // meta should be sorted but for the one item or empty case we can fall back to immutable maps to save some memory since order is
         // irrelevant
         this.meta = meta.size() <= 1 ? Map.copyOf(meta) : meta;
-        this.isSyntheticSourceEnabled = isSyntheticSourceEnabled;
-        this.isWithinMultiField = isWithinMultiField;
-    }
-
-    public boolean isSyntheticSourceEnabled() {
-        Objects.requireNonNull(isSyntheticSourceEnabled, "You're attempting to use isSyntheticSourceEnabled without setting it first!");
-        return isSyntheticSourceEnabled;
-    }
-
-    public boolean isWithinMultiField() {
-        Objects.requireNonNull(isWithinMultiField, "You're attempting to use isWithinMultiField without setting it first!");
-        return isWithinMultiField;
-    }
-
-    /**
-     * Returns the name of the "fallback" field that can be used for synthetic source when the "main" field was not
-     * stored for whatever reason.
-     */
-    public String syntheticSourceFallbackFieldName() {
-        return isSyntheticSourceEnabled ? name() + "._original" : null;
     }
 
     /**

server/src/main/java/org/elasticsearch/index/mapper/SimpleMappedFieldType.java

@@ -30,20 +30,7 @@ protected SimpleMappedFieldType(
         TextSearchInfo textSearchInfo,
         Map<String, String> meta
     ) {
-        this(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, null, null);
-    }
-
-    protected SimpleMappedFieldType(
-        String name,
-        boolean isIndexed,
-        boolean isStored,
-        boolean hasDocValues,
-        TextSearchInfo textSearchInfo,
-        Map<String, String> meta,
-        Boolean isSyntheticSourceEnabled,
-        Boolean isWithinMultiField
-    ) {
-        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, isSyntheticSourceEnabled, isWithinMultiField);
+        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta);
     }
 
     @Override

server/src/main/java/org/elasticsearch/index/mapper/StringFieldType.java

@@ -51,20 +51,7 @@ public StringFieldType(
         TextSearchInfo textSearchInfo,
         Map<String, String> meta
     ) {
-        this(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, null, null);
-    }
-
-    public StringFieldType(
-        String name,
-        boolean isIndexed,
-        boolean isStored,
-        boolean hasDocValues,
-        TextSearchInfo textSearchInfo,
-        Map<String, String> meta,
-        Boolean isSyntheticSourceEnabled,
-        Boolean isWithinMultiField
-    ) {
-        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, isSyntheticSourceEnabled, isWithinMultiField);
+        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta);
     }
 
     @Override

server/src/main/java/org/elasticsearch/index/mapper/TermBasedFieldType.java

@@ -34,20 +34,7 @@ public TermBasedFieldType(
         TextSearchInfo textSearchInfo,
         Map<String, String> meta
     ) {
-        this(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, null, null);
-    }
-
-    public TermBasedFieldType(
-        String name,
-        boolean isIndexed,
-        boolean isStored,
-        boolean hasDocValues,
-        TextSearchInfo textSearchInfo,
-        Map<String, String> meta,
-        Boolean isSyntheticSourceEnabled,
-        Boolean isWithinMultiField
-    ) {
-        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta, isSyntheticSourceEnabled, isWithinMultiField);
+        super(name, isIndexed, isStored, hasDocValues, textSearchInfo, meta);
     }
 
     /** Returns the indexed value used to construct search "values".

server/src/main/java/org/elasticsearch/index/mapper/TextFamilyFieldMapper.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.index.mapper;
+
+import org.elasticsearch.index.IndexVersion;
+
+public abstract class TextFamilyFieldMapper extends FieldMapper {
+
+    protected TextFamilyFieldMapper(String simpleName, MappedFieldType mappedFieldType, BuilderParams params) {
+        super(simpleName, mappedFieldType, params);
+    }
+
+    public abstract static class Builder extends FieldMapper.Builder {
+
+        private final IndexVersion indexCreatedVersion;
+        private final boolean isSyntheticSourceEnabled;
+        private final boolean isWithinMultiField;
+
+        protected Builder(String name, IndexVersion indexCreatedVersion, boolean isSyntheticSourceEnabled, boolean isWithinMultiField) {
+            super(name);
+            this.indexCreatedVersion = indexCreatedVersion;
+            this.isSyntheticSourceEnabled = isSyntheticSourceEnabled;
+            this.isWithinMultiField = isWithinMultiField;
+        }
+
+        public IndexVersion indexCreatedVersion() {
+            return indexCreatedVersion;
+        }
+
+        public boolean isSyntheticSourceEnabled() {
+            return isSyntheticSourceEnabled;
+        }
+
+        public boolean isWithinMultiField() {
+            return isWithinMultiField;
+        }
+
+    }
+
+}