org.opensearch.search.query.QueryCollectorContext Maven / Gradle / Ivy
/*
* 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.
*/
/*
* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.search.query;
import org.apache.lucene.search.Collector;
import org.apache.lucene.search.CollectorManager;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.MultiCollector;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.ScoreMode;
import org.apache.lucene.search.SimpleCollector;
import org.apache.lucene.search.Weight;
import org.opensearch.common.annotation.PublicApi;
import org.opensearch.common.lucene.MinimumScoreCollector;
import org.opensearch.common.lucene.search.FilteredCollector;
import org.opensearch.search.aggregations.AggregationCollectorManager;
import org.opensearch.search.aggregations.BucketCollector;
import org.opensearch.search.profile.query.CollectorResult;
import org.opensearch.search.profile.query.InternalProfileCollector;
import org.opensearch.search.profile.query.InternalProfileCollectorManager;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import static org.opensearch.search.profile.query.CollectorResult.REASON_SEARCH_MIN_SCORE;
import static org.opensearch.search.profile.query.CollectorResult.REASON_SEARCH_MULTI;
import static org.opensearch.search.profile.query.CollectorResult.REASON_SEARCH_POST_FILTER;
import static org.opensearch.search.profile.query.CollectorResult.REASON_SEARCH_TERMINATE_AFTER_COUNT;
/**
* The context used during query collection
*
* @opensearch.api
*/
@PublicApi(since = "1.0.0")
public abstract class QueryCollectorContext {
private static final Collector EMPTY_COLLECTOR = new SimpleCollector() {
@Override
public void collect(int doc) {}
@Override
public ScoreMode scoreMode() {
return ScoreMode.COMPLETE_NO_SCORES;
}
};
public static final QueryCollectorContext EMPTY_CONTEXT = new QueryCollectorContext("empty") {
@Override
Collector create(Collector in) throws IOException {
return EMPTY_COLLECTOR;
}
@Override
CollectorManager createManager(CollectorManager in) throws IOException {
return new CollectorManager() {
@Override
public Collector newCollector() throws IOException {
return EMPTY_COLLECTOR;
}
@Override
public ReduceableSearchResult reduce(Collection collectors) throws IOException {
return result -> {};
}
};
}
};
private String profilerName;
QueryCollectorContext(String profilerName) {
this.profilerName = profilerName;
}
/**
* Creates a collector that delegates documents to the provided in collector.
* @param in The delegate collector
*/
abstract Collector create(Collector in) throws IOException;
abstract CollectorManager createManager(CollectorManager in) throws IOException;
/**
* Wraps this collector with a profiler
*/
protected InternalProfileCollector createWithProfiler(InternalProfileCollector in) throws IOException {
final Collector collector = create(in);
return new InternalProfileCollector(collector, profilerName, in != null ? Collections.singletonList(in) : Collections.emptyList());
}
/**
* Wraps this collector manager with a profiler
*/
protected InternalProfileCollectorManager createWithProfiler(InternalProfileCollectorManager in) throws IOException {
final CollectorManager manager = createManager(in);
return new InternalProfileCollectorManager(
manager,
profilerName,
in != null ? Collections.singletonList(in) : Collections.emptyList()
);
}
/**
* Post-process result after search execution.
*
* @param result The query search result to populate
*/
void postProcess(QuerySearchResult result) throws IOException {}
/**
* Creates the collector tree from the provided collectors
* @param collectors Ordered list of collector context
*/
static Collector createQueryCollector(List collectors) throws IOException {
Collector collector = null;
for (QueryCollectorContext ctx : collectors) {
collector = ctx.create(collector);
}
return collector;
}
/**
* Creates the collector tree from the provided collectors and wraps each collector with a profiler
* @param collectors Ordered list of collector context
*/
static InternalProfileCollector createQueryCollectorWithProfiler(List collectors) throws IOException {
InternalProfileCollector collector = null;
for (QueryCollectorContext ctx : collectors) {
collector = ctx.createWithProfiler(collector);
}
return collector;
}
/**
* Filters documents with a query score greater than minScore
* @param minScore The minimum score filter
*/
static QueryCollectorContext createMinScoreCollectorContext(float minScore) {
return new QueryCollectorContext(REASON_SEARCH_MIN_SCORE) {
@Override
Collector create(Collector in) {
return new MinimumScoreCollector(in, minScore);
}
@Override
CollectorManager createManager(CollectorManager in) throws IOException {
return new MinimumCollectorManager(in, minScore);
}
};
}
/**
* Filters documents based on the provided query
*/
static QueryCollectorContext createFilteredCollectorContext(IndexSearcher searcher, Query query) {
return new QueryCollectorContext(REASON_SEARCH_POST_FILTER) {
@Override
Collector create(Collector in) throws IOException {
final Weight filterWeight = searcher.createWeight(searcher.rewrite(query), ScoreMode.COMPLETE_NO_SCORES, 1f);
return new FilteredCollector(in, filterWeight);
}
@Override
CollectorManager createManager(CollectorManager in) throws IOException {
final Weight filterWeight = searcher.createWeight(searcher.rewrite(query), ScoreMode.COMPLETE_NO_SCORES, 1f);
return new FilteredCollectorManager(in, filterWeight);
}
};
}
/**
* Creates a multi collector manager from the provided subs
*/
static QueryCollectorContext createMultiCollectorContext(
Collection> subs
) {
return new QueryCollectorContext(REASON_SEARCH_MULTI) {
@Override
Collector create(Collector in) throws IOException {
List subCollectors = new ArrayList<>();
subCollectors.add(in);
for (CollectorManager manager : subs) {
subCollectors.add(manager.newCollector());
}
return MultiCollector.wrap(subCollectors);
}
@Override
protected InternalProfileCollector createWithProfiler(InternalProfileCollector in) throws IOException {
final List subCollectors = new ArrayList<>();
subCollectors.add(in);
for (CollectorManager manager : subs) {
final Collector collector = manager.newCollector();
if (collector instanceof BucketCollector) {
subCollectors.add(
new InternalProfileCollector(collector, CollectorResult.REASON_AGGREGATION, Collections.emptyList())
);
} else {
subCollectors.add(
new InternalProfileCollector(collector, CollectorResult.REASON_SEARCH_MULTI, Collections.emptyList())
);
}
}
final Collector collector = MultiCollector.wrap(subCollectors);
return new InternalProfileCollector(collector, REASON_SEARCH_MULTI, subCollectors);
}
@Override
protected InternalProfileCollectorManager createWithProfiler(InternalProfileCollectorManager in) {
final List> managers = new ArrayList<>();
final List children = new ArrayList<>();
managers.add(in);
children.add(in);
for (CollectorManager manager : subs) {
final InternalProfileCollectorManager subCollectorManager;
if (manager instanceof AggregationCollectorManager) {
subCollectorManager = new InternalProfileCollectorManager(
manager,
((AggregationCollectorManager) manager).getCollectorReason(),
Collections.emptyList()
);
} else {
subCollectorManager = new InternalProfileCollectorManager(manager, REASON_SEARCH_MULTI, Collections.emptyList());
}
managers.add(subCollectorManager);
children.add(subCollectorManager);
}
CollectorManager multiCollectorManager = QueryCollectorManagerContext
.createMultiCollectorManager(managers);
return new InternalProfileCollectorManager(multiCollectorManager, REASON_SEARCH_MULTI, children);
}
@Override
CollectorManager createManager(
CollectorManager in
) throws IOException {
final List> managers = new ArrayList<>();
managers.add(in);
managers.addAll(subs);
return QueryCollectorManagerContext.createMultiCollectorManager(managers);
}
};
}
/**
* Creates collector limiting the collection to the first numHits documents
*/
static QueryCollectorContext createEarlyTerminationCollectorContext(int numHits) {
return new QueryCollectorContext(REASON_SEARCH_TERMINATE_AFTER_COUNT) {
private Collector collector;
/**
* Creates a {@link MultiCollector} to ensure that the {@link EarlyTerminatingCollector}
* can terminate the collection independently of the provided in {@link Collector}.
*/
@Override
Collector create(Collector in) {
assert collector == null;
List subCollectors = new ArrayList<>();
subCollectors.add(new EarlyTerminatingCollector(EMPTY_COLLECTOR, numHits, true));
subCollectors.add(in);
this.collector = MultiCollector.wrap(subCollectors);
return collector;
}
@Override
CollectorManager createManager(
CollectorManager in
) throws IOException {
return new EarlyTerminatingCollectorManager<>(in, numHits, true);
}
};
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy