Clean up and comments

Author: julian-elastic

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

@@ -137,6 +137,11 @@ public final Query wildcardQuery(String value, boolean caseInsensitive, QueryRew
         }
     }
 
+    /**
+     * Returns a query that matches all documents or no documents
+     * It usually calls {@link #wildcardQuery(String, boolean, QueryRewriteContext)}
+     * except for IndexFieldType which overrides this method to use its own matching logic.
+     */
     public Query wildcardLikeQuery(String value, boolean caseInsensitive, QueryRewriteContext context) {
         return wildcardQuery(value, caseInsensitive, context);
     }
@@ -147,8 +152,16 @@ public final boolean fieldHasValue(FieldInfos fieldInfos) {
         return true;
     }
 
+    /**
+     * Returns the constant value of this field as a string.
+     * Based on the field type, we need to get it in a different way.
+     */
     public abstract String getConstantFieldValue(SearchExecutionContext context);
 
+    /**
+     * Returns a query that matches all documents or no documents
+     * depending on whether the constant value of this field matches or not
+     */
     @Override
     public Query automatonQuery(
         Automaton automaton,

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

@@ -1045,6 +1045,7 @@ public boolean hasDocValuesSkipper() {
             return hasDocValuesSkipper;
         }
 
+        @Override
         public Query automatonQuery(
             Automaton automaton,
             @Nullable MultiTermQuery.RewriteMethod method,

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

@@ -330,6 +330,10 @@ public final Query wildcardQuery(String value, @Nullable MultiTermQuery.RewriteM
         return wildcardQuery(value, method, false, context);
     }
 
+    /**
+     * Similar to wildcardQuery, except that we change the behavior for
+     * this method for IndexFieldMapper
+     */
     public Query wildcardLikeQuery(
         String value,
         @Nullable MultiTermQuery.RewriteMethod method,
@@ -380,6 +384,10 @@ public Query regexpQuery(
         );
     }
 
+    /**
+     * Returns a Lucine pushable Query for the current field
+     * For now can only be AutomatonQuery or MatchAllDocsQuery() or MatchNoDocsQuery()
+     */
     public Query automatonQuery(
         Automaton automaton,
         @Nullable MultiTermQuery.RewriteMethod method,

server/src/main/java/org/elasticsearch/index/query/AutomatonQueryWithDescription.java

@@ -13,6 +13,11 @@
 import org.apache.lucene.search.AutomatonQuery;
 import org.apache.lucene.util.automaton.Automaton;
 
+/**
+ * A specialized {@link AutomatonQuery} that includes a description of the query.
+ * This can be useful for debugging or logging purposes, providing more context
+ * about the query being executed.
+ */
 public class AutomatonQueryWithDescription extends AutomatonQuery {
     private final String description;
 

server/src/main/java/org/elasticsearch/index/query/WildcardLikeQueryBuilder.java

@@ -16,6 +16,7 @@
 import org.elasticsearch.TransportVersion;
 import org.elasticsearch.TransportVersions;
 import org.elasticsearch.common.Strings;
+import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.xcontent.LoggingDeprecationHandler;
@@ -39,10 +40,13 @@
  * {@code ?}.
  */
 public class WildcardLikeQueryBuilder extends AbstractQueryBuilder<WildcardLikeQueryBuilder> implements MultiTermQueryBuilder {
-    public static final String NAME = "wildcardlike";
+    public static final NamedWriteableRegistry.Entry ENTRY = new NamedWriteableRegistry.Entry(
+        QueryBuilder.class,
+        "wildcardLikeQueryBuilder",
+        WildcardLikeQueryBuilder::new
+    );
 
     private static final ParseField WILDCARD_FIELD = new ParseField("wildcard");
-    private static final ParseField VALUE_FIELD = new ParseField("value");
     private static final ParseField REWRITE_FIELD = new ParseField("rewrite");
 
     private final String fieldName;
@@ -125,12 +129,12 @@ public boolean caseInsensitive() {
 
     @Override
     public String getWriteableName() {
-        return NAME;
+        return ENTRY.name;
     }
 
     @Override
     protected void doXContent(XContentBuilder builder, Params params) throws IOException {
-        builder.startObject(NAME);
+        builder.startObject(ENTRY.name);
         builder.startObject(fieldName);
         builder.field(WILDCARD_FIELD.getPreferredName(), value);
         if (rewrite != null) {

server/src/main/java/org/elasticsearch/search/SearchModule.java

@@ -66,7 +66,6 @@
 import org.elasticsearch.index.query.TermQueryBuilder;
 import org.elasticsearch.index.query.TermsQueryBuilder;
 import org.elasticsearch.index.query.TermsSetQueryBuilder;
-import org.elasticsearch.index.query.WildcardLikeQueryBuilder;
 import org.elasticsearch.index.query.WildcardQueryBuilder;
 import org.elasticsearch.index.query.WrapperQueryBuilder;
 import org.elasticsearch.index.query.functionscore.ExponentialDecayFunctionBuilder;
@@ -1118,9 +1117,6 @@ private void registerQueryParsers(List<SearchPlugin> plugins) {
         registerQuery(new QuerySpec<>(RangeQueryBuilder.NAME, RangeQueryBuilder::new, RangeQueryBuilder::fromXContent));
         registerQuery(new QuerySpec<>(PrefixQueryBuilder.NAME, PrefixQueryBuilder::new, PrefixQueryBuilder::fromXContent));
         registerQuery(new QuerySpec<>(WildcardQueryBuilder.NAME, WildcardQueryBuilder::new, WildcardQueryBuilder::fromXContent));
-        registerQuery(
-            new QuerySpec<>(WildcardLikeQueryBuilder.NAME, WildcardLikeQueryBuilder::new, WildcardLikeQueryBuilder::fromXContent)
-        );
         registerQuery(
             new QuerySpec<>(ConstantScoreQueryBuilder.NAME, ConstantScoreQueryBuilder::new, ConstantScoreQueryBuilder::fromXContent)
         );

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/capabilities/TranslationAware.java

@@ -48,10 +48,17 @@ static TranslationAware.Translatable translatable(Expression exp, LucenePushdown
      */
     Query asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler);
 
+    /**
+     * Translates the implementing expression into a Lucene {@link Automaton}.
+     */
     default Automaton asLuceneQuery() {
         throw new UnsupportedOperationException("asLuceneQuery is not implemented for " + getClass().getName());
     };
 
+    /**
+     * Returns a description of the Lucene query that this expression translates to.
+     * This is used for debugging and logging purposes.
+     */
     default String getLuceneQueryDescription() {
         throw new UnsupportedOperationException("getLuceneQueryDescription is not implemented for " + getClass().getName());
     };

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/regex/WildcardLikeList.java

@@ -8,14 +8,9 @@
 package org.elasticsearch.xpack.esql.expression.function.scalar.string.regex;
 
 import org.apache.lucene.util.automaton.Automaton;
-import org.elasticsearch.common.breaker.CircuitBreaker;
-import org.elasticsearch.common.breaker.NoopCircuitBreaker;
 import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.util.BigArrays;
-import org.elasticsearch.compute.data.BlockFactory;
-import org.elasticsearch.compute.data.BlockStreamInput;
 import org.elasticsearch.xpack.esql.core.expression.Expression;
 import org.elasticsearch.xpack.esql.core.expression.FieldAttribute;
 import org.elasticsearch.xpack.esql.core.expression.predicate.regex.WildcardPattern;
@@ -71,11 +66,8 @@ public WildcardLikeList(StreamInput in) throws IOException {
             in.readNamedWriteable(Expression.class),
             new WildcardPatternList(in),
             deserializeCaseInsensitivity(in),
-            null
+            Configuration.readFrom(in)
         );
-        BlockFactory blockFactory = new BlockFactory(new NoopCircuitBreaker(CircuitBreaker.REQUEST), BigArrays.NON_RECYCLING_INSTANCE);
-        BlockStreamInput blockStreamInput = new BlockStreamInput(in, blockFactory);
-        this.configuration = new Configuration(blockStreamInput);
     }
 
     @Override

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/io/stream/ExpressionQuery.java

@@ -15,7 +15,7 @@
 import java.util.Objects;
 
 /**
- * Query that matches documents based on a Lucene Automaton.
+ * Implements an Expression query, which matches documents based on a given expression.
  */
 public class ExpressionQuery extends Query {
 
@@ -60,6 +60,6 @@ public boolean equals(Object obj) {
 
     @Override
     protected String innerToString() {
-        return "AutomatonQuery{" + "field='" + targetFieldName + '\'' + '}';
+        return "ExpressionQuery{" + "field='" + targetFieldName + '\'' + '}';
     }
 }

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/io/stream/ExpressionQueryBuilder.java

@@ -7,21 +7,14 @@
 
 package org.elasticsearch.xpack.esql.io.stream;
 
-import org.apache.lucene.index.Term;
-import org.apache.lucene.search.AutomatonQuery;
 import org.apache.lucene.search.MatchNoDocsQuery;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.util.automaton.Automaton;
 import org.elasticsearch.TransportVersion;
 import org.elasticsearch.common.Strings;
-import org.elasticsearch.common.breaker.CircuitBreaker;
-import org.elasticsearch.common.breaker.NoopCircuitBreaker;
 import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.util.BigArrays;
-import org.elasticsearch.compute.data.BlockFactory;
-import org.elasticsearch.compute.data.BlockStreamInput;
 import org.elasticsearch.index.mapper.MappedFieldType;
 import org.elasticsearch.index.query.AbstractQueryBuilder;
 import org.elasticsearch.index.query.MultiTermQueryBuilder;
@@ -39,8 +32,10 @@
 import static org.apache.lucene.search.MultiTermQuery.CONSTANT_SCORE_REWRITE;
 
 /**
- * Implements an Automaton query, which matches documents based on a Lucene Automaton.
- * It does not support serialization or XContent representation.
+ * Implements an Expression query builder, which matches documents based on a given expression.
+ * The expression itself must provide the asLuceneQuery and getLuceneQueryDescription methods
+ * It allows for serialization of the expression and generate an AutomatonQuery on the data node
+ * as Automaton does not support serialization.
  */
 public class ExpressionQueryBuilder extends AbstractQueryBuilder<ExpressionQueryBuilder> implements MultiTermQueryBuilder {
     public static final NamedWriteableRegistry.Entry ENTRY = new NamedWriteableRegistry.Entry(
@@ -70,10 +65,8 @@ public ExpressionQueryBuilder(String fieldName, Expression expression, Configura
     public ExpressionQueryBuilder(StreamInput in) throws IOException {
         super(in);
         fieldName = in.readString();
-        BlockFactory blockFactory = new BlockFactory(new NoopCircuitBreaker(CircuitBreaker.REQUEST), BigArrays.NON_RECYCLING_INSTANCE);
-        BlockStreamInput blockStreamInput = new BlockStreamInput(in, blockFactory);
-        this.config = new Configuration(blockStreamInput);
-        PlanStreamInput planStreamInput = new PlanStreamInput(blockStreamInput, in.namedWriteableRegistry(), config);
+        this.config = Configuration.readFrom(in);
+        PlanStreamInput planStreamInput = new PlanStreamInput(in, in.namedWriteableRegistry(), config);
         this.expression = planStreamInput.readNamedWriteable(Expression.class);
     }
 
@@ -129,21 +122,4 @@ protected boolean doEquals(ExpressionQueryBuilder other) {
     public TransportVersion getMinimalSupportedVersion() {
         throw new UnsupportedOperationException("AutomatonQueryBuilder does not support getMinimalSupportedVersion");
     }
-
-    static class AutomatonQueryWithDescription extends AutomatonQuery {
-        private final String description;
-
-        AutomatonQueryWithDescription(Term term, Automaton automaton, String description) {
-            super(term, automaton);
-            this.description = description;
-        }
-
-        @Override
-        public String toString(String field) {
-            if (this.field.equals(field)) {
-                return description;
-            }
-            return this.field + ":" + description;
-        }
-    }
 }