com.google.gerrit.server.query

Class QueryProcessor<T>

java.lang.Object

com.google.gerrit.server.query.QueryProcessor<T>

Direct Known Subclasses:

AccountQueryProcessor, ChangeQueryProcessor, GroupQueryProcessor

public abstract class QueryProcessor<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QueryProcessor.Metrics

Field Summary

Fields

Modifier and Type	Field and Description
protected int	start
protected com.google.inject.Provider<CurrentUser>	userProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryProcessor(com.google.inject.Provider<CurrentUser> userProvider, QueryProcessor.Metrics metrics, SchemaDefinitions<T> schemaDef, IndexConfig indexConfig, IndexCollection<?,T,? extends Index<?,T>> indexes, IndexRewriter<T> rewriter, String limitField)

Method Summary

Modifier and Type	Method and Description
protected QueryOptions	createOptions(IndexConfig indexConfig, int start, int limit, Set<String> requestedFields)
QueryProcessor<T>	enforceVisibility(boolean enforce)
protected abstract Predicate<T>	enforceVisibility(Predicate<T> pred) Invoked after the query was rewritten.
boolean	isDisabled()
List<QueryResult<T>>	query(List<Predicate<T>> queries) Perform multiple queries in parallel.
QueryResult<T>	query(Predicate<T> query) Query for entities that match a structured query.
QueryProcessor<T>	setLimit(int n)
QueryProcessor<T>	setRequestedFields(Set<String> fields)
QueryProcessor<T>	setStart(int n)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userProvider

protected final com.google.inject.Provider<CurrentUser> userProvider

start

protected int start

Constructor Detail

QueryProcessor

protected QueryProcessor(com.google.inject.Provider<CurrentUser> userProvider,
                         QueryProcessor.Metrics metrics,
                         SchemaDefinitions<T> schemaDef,
                         IndexConfig indexConfig,
                         IndexCollection<?,T,? extends Index<?,T>> indexes,
                         IndexRewriter<T> rewriter,
                         String limitField)

Method Detail

setStart

public QueryProcessor<T> setStart(int n)

enforceVisibility

public QueryProcessor<T> enforceVisibility(boolean enforce)

setLimit

public QueryProcessor<T> setLimit(int n)

setRequestedFields

public QueryProcessor<T> setRequestedFields(Set<String> fields)

query

public QueryResult<T> query(Predicate<T> query)
                     throws com.google.gwtorm.server.OrmException,
                            QueryParseException

Query for entities that match a structured query.

Parameters:

query - the query.

Returns:

results of the query.

Throws:

com.google.gwtorm.server.OrmException

QueryParseException

See Also:

query(List)

query

public List<QueryResult<T>> query(List<Predicate<T>> queries)
                           throws com.google.gwtorm.server.OrmException,
                                  QueryParseException

Perform multiple queries in parallel.

Parameters:

queries - list of queries.

Returns:

results of the queries, one QueryResult per input query, in the same order as the input.

Throws:

com.google.gwtorm.server.OrmException

QueryParseException

createOptions

protected QueryOptions createOptions(IndexConfig indexConfig,
                                     int start,
                                     int limit,
                                     Set<String> requestedFields)

enforceVisibility

protected abstract Predicate<T> enforceVisibility(Predicate<T> pred)

Invoked after the query was rewritten. Subclasses must overwrite this method to filter out results that are not visible to the calling user.

Parameters:

pred - the query

Returns:

the modified query

isDisabled

public boolean isDisabled()