Query refactoring: SpanNearQueryBuilder and Parser #12156
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,70 +19,180 @@ | |
|
|
||
| package org.elasticsearch.index.query; | ||
|
|
||
| import org.apache.lucene.search.Query; | ||
| import org.apache.lucene.search.spans.SpanNearQuery; | ||
| import org.apache.lucene.search.spans.SpanQuery; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * Matches spans which are near one another. One can specify slop, the maximum number | ||
| * of intervening unmatched positions, as well as whether matches are required to be in-order. | ||
| * The span near query maps to Lucene {@link SpanNearQuery}. | ||
| */ | ||
| public class SpanNearQueryBuilder extends AbstractQueryBuilder<SpanNearQueryBuilder> implements SpanQueryBuilder<SpanNearQueryBuilder> { | ||
|
|
||
| public static final String NAME = "span_near"; | ||
|
|
||
| /** Default for flag controlling whether matches are required to be in-order */ | ||
| public static boolean DEFAULT_IN_ORDER = true; | ||
|
|
||
| /** Default for flag controlling whether payloads are collected */ | ||
| public static boolean DEFAULT_COLLECT_PAYLOADS = true; | ||
|
|
||
| private final ArrayList<SpanQueryBuilder> clauses = new ArrayList<>(); | ||
|
|
||
| private final int slop; | ||
|
|
||
| private boolean inOrder = DEFAULT_IN_ORDER; | ||
|
|
||
| private boolean collectPayloads = DEFAULT_COLLECT_PAYLOADS; | ||
|
|
||
| static final SpanNearQueryBuilder PROTOTYPE = new SpanNearQueryBuilder(); | ||
|
|
||
| /** | ||
| * @param slop controls the maximum number of intervening unmatched positions permitted | ||
| */ | ||
| public SpanNearQueryBuilder(int slop) { | ||
| this.slop = slop; | ||
| } | ||
|
|
||
| /** | ||
| * only used for prototype | ||
| */ | ||
| private SpanNearQueryBuilder() { | ||
| this.slop = 0; | ||
| } | ||
|
|
||
| /** | ||
| * @return the maximum number of intervening unmatched positions permitted | ||
| */ | ||
| public int slop() { | ||
| return this.slop; | ||
| } | ||
|
|
||
| public SpanNearQueryBuilder clause(SpanQueryBuilder clause) { | ||
| clauses.add(Objects.requireNonNull(clause)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @return the {@link SpanQueryBuilder} clauses that were set for this query | ||
| */ | ||
| public List<SpanQueryBuilder> clauses() { | ||
| return this.clauses; | ||
| } | ||
|
|
||
| /** | ||
| * When <code>inOrder</code> is true, the spans from each clause | ||
| * must be in the same order as in <code>clauses</code> and must be non-overlapping. | ||
| * Defaults to <code>true</code> | ||
| */ | ||
| public SpanNearQueryBuilder inOrder(boolean inOrder) { | ||
| this.inOrder = inOrder; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @see SpanNearQueryBuilder#inOrder(boolean)) | ||
| */ | ||
| public boolean inOrder() { | ||
| return this.inOrder; | ||
| } | ||
|
|
||
| /** | ||
| * @param collectPayloads flag controlling whether payloads are collected | ||
| */ | ||
| public SpanNearQueryBuilder collectPayloads(boolean collectPayloads) { | ||
| this.collectPayloads = collectPayloads; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * @see SpanNearQueryBuilder#collectPayloads(boolean)) | ||
| */ | ||
| public boolean collectPayloads() { | ||
| return this.collectPayloads; | ||
| } | ||
|
|
||
| @Override | ||
| protected void doXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(NAME); | ||
| builder.startArray("clauses"); | ||
| for (SpanQueryBuilder clause : clauses) { | ||
| clause.toXContent(builder, params); | ||
| } | ||
| builder.endArray(); | ||
| builder.field("slop", slop); | ||
| builder.field("in_order", inOrder); | ||
| builder.field("collect_payloads", collectPayloads); | ||
| printBoostAndQueryName(builder); | ||
| builder.endObject(); | ||
| } | ||
|
|
||
| @Override | ||
| protected Query doToQuery(QueryParseContext parseContext) throws IOException { | ||
| SpanQuery[] spanQueries = new SpanQuery[clauses.size()]; | ||
| for (int i = 0; i < clauses.size(); i++) { | ||
| Query query = clauses.get(i).toQuery(parseContext); | ||
| assert query instanceof SpanQuery; | ||
| spanQueries[i] = (SpanQuery) query; | ||
| } | ||
| return new SpanNearQuery(spanQueries, slop, inOrder, collectPayloads); | ||
| } | ||
|
|
||
| @Override | ||
| public QueryValidationException validate() { | ||
| QueryValidationException validationExceptions = null; | ||
| if (clauses.isEmpty()) { | ||
| validationExceptions = addValidationError("query must include [clauses]", validationExceptions); | ||
| } | ||
| for (SpanQueryBuilder innerClause : clauses) { | ||
| validationExceptions = validateInnerQuery(innerClause, validationExceptions); | ||
| } | ||
|
There was a problem hiding this comment. According to this #3673 it can officially be "-1", don't know if any other negative values make sense, so I accepted them. |
||
| return validationExceptions; | ||
| } | ||
|
|
||
| @Override | ||
| protected SpanNearQueryBuilder doReadFrom(StreamInput in) throws IOException { | ||
| SpanNearQueryBuilder queryBuilder = new SpanNearQueryBuilder(in.readVInt()); | ||
| List<SpanQueryBuilder> clauses = in.readNamedWriteableList(); | ||
| for (SpanQueryBuilder subClause : clauses) { | ||
| queryBuilder.clause(subClause); | ||
| } | ||
| queryBuilder.collectPayloads = in.readBoolean(); | ||
| queryBuilder.inOrder = in.readBoolean(); | ||
| return queryBuilder; | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| protected void doWriteTo(StreamOutput out) throws IOException { | ||
| out.writeVInt(slop); | ||
| out.writeNamedWriteableList(clauses); | ||
| out.writeBoolean(collectPayloads); | ||
| out.writeBoolean(inOrder); | ||
| } | ||
|
|
||
| @Override | ||
| protected int doHashCode() { | ||
| return Objects.hash(clauses, slop, collectPayloads, inOrder); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean doEquals(SpanNearQueryBuilder other) { | ||
| return Objects.equals(clauses, other.clauses) && | ||
| Objects.equals(slop, other.slop) && | ||
| Objects.equals(collectPayloads, other.collectPayloads) && | ||
| Objects.equals(inOrder, other.inOrder); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return NAME; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.index.query; | ||
|
|
||
| import org.apache.lucene.search.Query; | ||
| import org.apache.lucene.search.spans.SpanNearQuery; | ||
| import org.apache.lucene.search.spans.SpanQuery; | ||
| import org.junit.Test; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| public class SpanNearQueryBuilderTest extends BaseQueryTestCase<SpanNearQueryBuilder> { | ||
|
|
||
| @Override | ||
| protected Query doCreateExpectedQuery(SpanNearQueryBuilder testQueryBuilder, QueryParseContext context) throws IOException { | ||
| List<SpanQueryBuilder> clauses = testQueryBuilder.clauses(); | ||
| SpanQuery[] spanQueries = new SpanQuery[clauses.size()]; | ||
| for (int i = 0; i < clauses.size(); i++) { | ||
| Query query = clauses.get(i).toQuery(context); | ||
| assert query instanceof SpanQuery; | ||
| spanQueries[i] = (SpanQuery) query; | ||
| } | ||
| return new SpanNearQuery(spanQueries, testQueryBuilder.slop(), testQueryBuilder.inOrder(), testQueryBuilder.collectPayloads()); | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| protected SpanNearQueryBuilder doCreateTestQueryBuilder() { | ||
| SpanNearQueryBuilder queryBuilder = new SpanNearQueryBuilder(randomIntBetween(-10, 10)); | ||
| int clauses = randomIntBetween(1, 6); | ||
| // we use one random SpanTermQueryBuilder to determine same field name for subsequent clauses | ||
| String fieldName = new SpanTermQueryBuilderTest().createTestQueryBuilder().fieldName(); | ||
| for (int i = 0; i < clauses; i++) { | ||
| // we need same field name in all clauses, so we only randomize value | ||
| Object value; | ||
| switch (fieldName) { | ||
| case BOOLEAN_FIELD_NAME: value = randomBoolean(); break; | ||
| case INT_FIELD_NAME: value = randomInt(); break; | ||
| case DOUBLE_FIELD_NAME: value = randomDouble(); break; | ||
| case STRING_FIELD_NAME: value = randomAsciiOfLengthBetween(1, 10); break; | ||
| default : value = randomAsciiOfLengthBetween(1, 10); | ||
| } | ||
| queryBuilder.clause(new SpanTermQueryBuilder(fieldName, value)); | ||
| } | ||
| queryBuilder.inOrder(randomBoolean()); | ||
| queryBuilder.collectPayloads(randomBoolean()); | ||
| return queryBuilder; | ||
| } | ||
|
|
||
| @Test | ||
| public void testValidate() { | ||
| SpanNearQueryBuilder queryBuilder = new SpanNearQueryBuilder(1); | ||
| assertValidate(queryBuilder, 1); // empty clause list | ||
|
|
||
| int totalExpectedErrors = 0; | ||
| int clauses = randomIntBetween(1, 10); | ||
| for (int i = 0; i < clauses; i++) { | ||
| if (randomBoolean()) { | ||
| queryBuilder.clause(new SpanTermQueryBuilder("", "test")); | ||
| totalExpectedErrors++; | ||
| } else { | ||
| queryBuilder.clause(new SpanTermQueryBuilder("name", "value")); | ||
| } | ||
| } | ||
| assertValidate(queryBuilder, totalExpectedErrors); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
set a negative value maybe?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to this #3673 it can officially be "-1", don't know if any other negative values make sense. Lucene doesn't seem to complain. Since this is the prototype setting I can set it to any large negative value probably.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't matter that much, I thought -1 didn't make sense :)