summaryrefslogtreecommitdiffstats
path: root/java/com/google/gerrit/index/query/InternalQuery.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/com/google/gerrit/index/query/InternalQuery.java')
-rw-r--r--java/com/google/gerrit/index/query/InternalQuery.java109
1 files changed, 109 insertions, 0 deletions
diff --git a/java/com/google/gerrit/index/query/InternalQuery.java b/java/com/google/gerrit/index/query/InternalQuery.java
new file mode 100644
index 0000000000..3a4b372e36
--- /dev/null
+++ b/java/com/google/gerrit/index/query/InternalQuery.java
@@ -0,0 +1,109 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// Licensed 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 com.google.gerrit.index.query;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.stream.Collectors.toSet;
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Lists;
+import com.google.gerrit.index.FieldDef;
+import com.google.gerrit.index.Index;
+import com.google.gerrit.index.IndexCollection;
+import com.google.gerrit.index.IndexConfig;
+import com.google.gerrit.index.Schema;
+import com.google.gwtorm.server.OrmException;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Execute a single query over a secondary index, for use by Gerrit internals.
+ *
+ * <p>By default, visibility of returned entities is not enforced (unlike in {@link
+ * QueryProcessor}). The methods in this class are not typically used by user-facing paths, but
+ * rather by internal callers that need to process all matching results.
+ *
+ * <p>Instances are one-time-use. Other singleton classes should inject a Provider rather than
+ * holding on to a single instance.
+ */
+public class InternalQuery<T> {
+ private final QueryProcessor<T> queryProcessor;
+ private final IndexCollection<?, T, ? extends Index<?, T>> indexes;
+
+ protected final IndexConfig indexConfig;
+
+ protected InternalQuery(
+ QueryProcessor<T> queryProcessor,
+ IndexCollection<?, T, ? extends Index<?, T>> indexes,
+ IndexConfig indexConfig) {
+ this.queryProcessor = queryProcessor.enforceVisibility(false);
+ this.indexes = indexes;
+ this.indexConfig = indexConfig;
+ }
+
+ public InternalQuery<T> setLimit(int n) {
+ queryProcessor.setUserProvidedLimit(n);
+ return this;
+ }
+
+ public InternalQuery<T> enforceVisibility(boolean enforce) {
+ queryProcessor.enforceVisibility(enforce);
+ return this;
+ }
+
+ @SuppressWarnings("unchecked") // Can't set @SafeVarargs on a non-final method.
+ public InternalQuery<T> setRequestedFields(FieldDef<T, ?>... fields) {
+ checkArgument(fields.length > 0, "requested field list is empty");
+ queryProcessor.setRequestedFields(
+ Arrays.stream(fields).map(FieldDef::getName).collect(toSet()));
+ return this;
+ }
+
+ public InternalQuery<T> noFields() {
+ queryProcessor.setRequestedFields(ImmutableSet.of());
+ return this;
+ }
+
+ public List<T> query(Predicate<T> p) throws OrmException {
+ try {
+ return queryProcessor.query(p).entities();
+ } catch (QueryParseException e) {
+ throw new OrmException(e);
+ }
+ }
+
+ /**
+ * Run multiple queries in parallel.
+ *
+ * <p>If a limit was specified using {@link #setLimit(int)}, that limit is applied to each query
+ * independently.
+ *
+ * @param queries list of queries.
+ * @return results of the queries, one list of results per input query, in the same order as the
+ * input.
+ */
+ public List<List<T>> query(List<Predicate<T>> queries) throws OrmException {
+ try {
+ return Lists.transform(queryProcessor.query(queries), QueryResult::entities);
+ } catch (QueryParseException e) {
+ throw new OrmException(e);
+ }
+ }
+
+ protected Schema<T> schema() {
+ Index<?, T> index = indexes != null ? indexes.getSearchIndex() : null;
+ return index != null ? index.getSchema() : null;
+ }
+}