ChangeQueryBuilder (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.query.QueryBuilder<ChangeData>
- - com.google.gerrit.server.query.change.ChangeQueryBuilder

public class ChangeQueryBuilder
extends QueryBuilder<ChangeData>

Parses a query string meant to be applied to change objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChangeQueryBuilder.Arguments

static interface ChangeQueryBuilder.Factory
- Nested classes/interfaces inherited from class com.google.gerrit.server.query.QueryBuilder
  QueryBuilder.Definition<T,Q extends QueryBuilder<T>>, QueryBuilder.Operator, QueryBuilder.OperatorFactory<T,Q extends QueryBuilder<T>>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeQueryBuilder.Arguments`
`static interface`	`ChangeQueryBuilder.Factory`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARG_ID_GROUP`
`static String`	`ARG_ID_USER`
`static String`	`FIELD_AFTER`
`static String`	`FIELD_AGE`
`static String`	`FIELD_BEFORE`
`static String`	`FIELD_BRANCH`
`static String`	`FIELD_CHANGE`
`static String`	`FIELD_COMMENT`
`static String`	`FIELD_COMMIT`
`static String`	`FIELD_CONFLICTS`
`static String`	`FIELD_DRAFTBY`
`static String`	`FIELD_FILE`
`static String`	`FIELD_HAS`
`static String`	`FIELD_IS`
`static String`	`FIELD_LABEL`
`static String`	`FIELD_LIMIT`
`static String`	`FIELD_MERGEABLE`
`static String`	`FIELD_MESSAGE`
`static String`	`FIELD_OWNER`
`static String`	`FIELD_OWNERIN`
`static String`	`FIELD_PARENTPROJECT`
`static String`	`FIELD_PATH`
`static String`	`FIELD_PROJECT`
`static String`	`FIELD_REF`
`static String`	`FIELD_REVIEWER`
`static String`	`FIELD_REVIEWERIN`
`static String`	`FIELD_STARREDBY`
`static String`	`FIELD_STATUS`
`static String`	`FIELD_TOPIC`
`static String`	`FIELD_TR`
`static String`	`FIELD_VISIBLETO`
`static String`	`FIELD_WATCHEDBY`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ChangeQueryBuilder(ChangeQueryBuilder.Arguments args, CurrentUser currentUser)`
`protected`	`ChangeQueryBuilder(QueryBuilder.Definition<ChangeData,? extends ChangeQueryBuilder> def, ChangeQueryBuilder.Arguments args, CurrentUser currentUser)`

Method Summary

Methods
Modifier and Type	Method and Description
`Predicate<ChangeData>`	`after(String value)`
`Predicate<ChangeData>`	`age(String value)`
`Predicate<ChangeData>`	`before(String value)`
`Predicate<ChangeData>`	`branch(String name)`
`Predicate<ChangeData>`	`bug(String trackingId)`
`Predicate<ChangeData>`	`change(String query)`
`Predicate<ChangeData>`	`comment(String value)`
`Predicate<ChangeData>`	`commit(String id)`
`Predicate<ChangeData>`	`conflicts(String value)`
`protected Predicate<ChangeData>`	`defaultField(String query)` Handle a value present outside of an operator.
`Predicate<ChangeData>`	`draftby(String who)`
`Predicate<ChangeData>`	`f(String file)`
`Predicate<ChangeData>`	`file(String file)`
`static Integer`	`getLimit(Predicate<ChangeData> p)`
`Predicate<ChangeData>`	`has(String value)`
`static boolean`	`hasNonTrivialSortKeyAfter(Schema<ChangeData> schema, Predicate<ChangeData> p)`
`static boolean`	`hasSortKey(Predicate<ChangeData> p)`
`Predicate<ChangeData>`	`is_visible()`
`Predicate<ChangeData>`	`is(String value)`
`Predicate<ChangeData>`	`label(String name)`
`Predicate<ChangeData>`	`limit(int limit)`
`Predicate<ChangeData>`	`limit(String limit)`
`Predicate<ChangeData>`	`message(String text)`
`Predicate<ChangeData>`	`o(String who)`
`Predicate<ChangeData>`	`owner(String who)`
`Predicate<ChangeData>`	`ownerin(String group)`
`Predicate<ChangeData>`	`p(String name)`
`Predicate<ChangeData>`	`parentproject(String name)`
`Predicate<ChangeData>`	`path(String path)`
`Predicate<ChangeData>`	`project(String name)`
`Predicate<ChangeData>`	`r(String who)`
`Predicate<ChangeData>`	`ref(String ref)`
`Predicate<ChangeData>`	`resume_sortkey(String sortKey)`
`Predicate<ChangeData>`	`reviewer(String who)`
`Predicate<ChangeData>`	`reviewerin(String group)`
`Predicate<ChangeData>`	`since(String value)`
`Predicate<ChangeData>`	`sortkey_after(String sortKey)`
`Predicate<ChangeData>`	`sortkey_before(String sortKey)`
`Predicate<ChangeData>`	`starredby(String who)`
`Predicate<ChangeData>`	`status_open()`
`Predicate<ChangeData>`	`status(String statusName)`
`Predicate<ChangeData>`	`topic(String name)`
`Predicate<ChangeData>`	`tr(String trackingId)`
`Predicate<ChangeData>`	`until(String value)`
`Predicate<ChangeData>`	`visibleto(CurrentUser user)`
`Predicate<ChangeData>`	`visibleto(String who)`
`Predicate<ChangeData>`	`watchedby(String who)`

Methods inherited from class com.google.gerrit.server.query.QueryBuilder
error, error, find, find, parse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_AFTER
```
public static final String FIELD_AFTER
```
See Also:
Constant Field Values

FIELD_AGE
```
public static final String FIELD_AGE
```
See Also:
Constant Field Values

FIELD_BEFORE

public static final String FIELD_BEFORE

See Also:: Constant Field Values

FIELD_BRANCH

public static final String FIELD_BRANCH

See Also:: Constant Field Values

FIELD_CHANGE

public static final String FIELD_CHANGE

See Also:: Constant Field Values

FIELD_COMMENT

public static final String FIELD_COMMENT

See Also:: Constant Field Values

FIELD_COMMIT

public static final String FIELD_COMMIT

See Also:: Constant Field Values

FIELD_CONFLICTS

public static final String FIELD_CONFLICTS

See Also:: Constant Field Values

FIELD_DRAFTBY

public static final String FIELD_DRAFTBY

See Also:: Constant Field Values

FIELD_FILE
```
public static final String FIELD_FILE
```
See Also:
Constant Field Values

FIELD_IS
```
public static final String FIELD_IS
```
See Also:
Constant Field Values

FIELD_HAS
```
public static final String FIELD_HAS
```
See Also:
Constant Field Values

FIELD_LABEL
```
public static final String FIELD_LABEL
```
See Also:
Constant Field Values

FIELD_LIMIT
```
public static final String FIELD_LIMIT
```
See Also:
Constant Field Values

FIELD_MERGEABLE

public static final String FIELD_MERGEABLE

See Also:: Constant Field Values

FIELD_MESSAGE

public static final String FIELD_MESSAGE

See Also:: Constant Field Values

FIELD_OWNER
```
public static final String FIELD_OWNER
```
See Also:
Constant Field Values

FIELD_OWNERIN

public static final String FIELD_OWNERIN

See Also:: Constant Field Values

FIELD_PARENTPROJECT

public static final String FIELD_PARENTPROJECT

See Also:: Constant Field Values

FIELD_PATH
```
public static final String FIELD_PATH
```
See Also:
Constant Field Values

FIELD_PROJECT

public static final String FIELD_PROJECT

See Also:: Constant Field Values

FIELD_REF
```
public static final String FIELD_REF
```
See Also:
Constant Field Values

FIELD_REVIEWER

public static final String FIELD_REVIEWER

See Also:: Constant Field Values

FIELD_REVIEWERIN

public static final String FIELD_REVIEWERIN

See Also:: Constant Field Values

FIELD_STARREDBY

public static final String FIELD_STARREDBY

See Also:: Constant Field Values

FIELD_STATUS

public static final String FIELD_STATUS

See Also:: Constant Field Values

FIELD_TOPIC
```
public static final String FIELD_TOPIC
```
See Also:
Constant Field Values

FIELD_TR
```
public static final String FIELD_TR
```
See Also:
Constant Field Values

FIELD_VISIBLETO

public static final String FIELD_VISIBLETO

See Also:: Constant Field Values

FIELD_WATCHEDBY

public static final String FIELD_WATCHEDBY

See Also:: Constant Field Values

ARG_ID_USER
```
public static final String ARG_ID_USER
```
See Also:
Constant Field Values

ARG_ID_GROUP

public static final String ARG_ID_GROUP

See Also:: Constant Field Values

Constructor Detail

ChangeQueryBuilder

@Inject
public ChangeQueryBuilder(ChangeQueryBuilder.Arguments args,
                         CurrentUser currentUser)

ChangeQueryBuilder

protected ChangeQueryBuilder(QueryBuilder.Definition<ChangeData,? extends ChangeQueryBuilder> def,
                  ChangeQueryBuilder.Arguments args,
                  CurrentUser currentUser)

Method Detail

getLimit

public static Integer getLimit(Predicate<ChangeData> p)

hasNonTrivialSortKeyAfter

public static boolean hasNonTrivialSortKeyAfter(Schema<ChangeData> schema,
                                Predicate<ChangeData> p)

hasSortKey

public static boolean hasSortKey(Predicate<ChangeData> p)

age

public Predicate<ChangeData> age(String value)

before

public Predicate<ChangeData> before(String value)
                             throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

until

public Predicate<ChangeData> until(String value)
                            throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

after

public Predicate<ChangeData> after(String value)
                            throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

since

public Predicate<ChangeData> since(String value)
                            throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

change

public Predicate<ChangeData> change(String query)

comment

public Predicate<ChangeData> comment(String value)
                              throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

status

public Predicate<ChangeData> status(String statusName)

status_open

public Predicate<ChangeData> status_open()

has

public Predicate<ChangeData> has(String value)

is

public Predicate<ChangeData> is(String value)
                         throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

commit

public Predicate<ChangeData> commit(String id)

conflicts

public Predicate<ChangeData> conflicts(String value)
                                throws com.google.gwtorm.server.OrmException,
                                       com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gwtorm.server.OrmException; com.google.gerrit.server.query.QueryParseException

p

public Predicate<ChangeData> p(String name)

project

public Predicate<ChangeData> project(String name)

parentproject

public Predicate<ChangeData> parentproject(String name)

branch

public Predicate<ChangeData> branch(String name)

topic

public Predicate<ChangeData> topic(String name)

ref

public Predicate<ChangeData> ref(String ref)

f

public Predicate<ChangeData> f(String file)
                        throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

file

public Predicate<ChangeData> file(String file)
                           throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

path

public Predicate<ChangeData> path(String path)
                           throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

label

public Predicate<ChangeData> label(String name)
                            throws com.google.gerrit.server.query.QueryParseException,
                                   com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

message

public Predicate<ChangeData> message(String text)
                              throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

starredby

public Predicate<ChangeData> starredby(String who)
                                throws com.google.gerrit.server.query.QueryParseException,
                                       com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

watchedby

public Predicate<ChangeData> watchedby(String who)
                                throws com.google.gerrit.server.query.QueryParseException,
                                       com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

draftby

public Predicate<ChangeData> draftby(String who)
                              throws com.google.gerrit.server.query.QueryParseException,
                                     com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

visibleto

public Predicate<ChangeData> visibleto(String who)
                                throws com.google.gerrit.server.query.QueryParseException,
                                       com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

visibleto

public Predicate<ChangeData> visibleto(CurrentUser user)

is_visible

public Predicate<ChangeData> is_visible()

o

public Predicate<ChangeData> o(String who)
                        throws com.google.gerrit.server.query.QueryParseException,
                               com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

owner

public Predicate<ChangeData> owner(String who)
                            throws com.google.gerrit.server.query.QueryParseException,
                                   com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

ownerin

public Predicate<ChangeData> ownerin(String group)
                              throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

r

public Predicate<ChangeData> r(String who)
                        throws com.google.gerrit.server.query.QueryParseException,
                               com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

reviewer

public Predicate<ChangeData> reviewer(String who)
                               throws com.google.gerrit.server.query.QueryParseException,
                                      com.google.gwtorm.server.OrmException

Throws:: com.google.gerrit.server.query.QueryParseException; com.google.gwtorm.server.OrmException

reviewerin

public Predicate<ChangeData> reviewerin(String group)
                                 throws com.google.gerrit.server.query.QueryParseException

Throws:: com.google.gerrit.server.query.QueryParseException

tr

public Predicate<ChangeData> tr(String trackingId)

bug

public Predicate<ChangeData> bug(String trackingId)

limit

public Predicate<ChangeData> limit(String limit)

limit

public Predicate<ChangeData> limit(int limit)

sortkey_after

public Predicate<ChangeData> sortkey_after(String sortKey)

sortkey_before

public Predicate<ChangeData> sortkey_before(String sortKey)

resume_sortkey

public Predicate<ChangeData> resume_sortkey(String sortKey)

defaultField
```
protected Predicate<ChangeData> defaultField(String query)
                                      throws com.google.gerrit.server.query.QueryParseException
```
Description copied from class: QueryBuilder

Handle a value present outside of an operator.
This default implementation always throws an "Unsupported query: " message containing the input text. Subclasses may override this method to perform do-what-i-mean guesses based on the input string.

Overrides:

defaultField in class QueryBuilder<ChangeData>

Parameters:
query - the value supplied by itself in the query.

Returns:
predicate representing this value.

Throws:

QueryParseException - the parser does not recognize this value.

Class ChangeQueryBuilder

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.query.QueryBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.query.QueryBuilder

Methods inherited from class java.lang.Object

Field Detail

FIELD_AFTER

FIELD_AGE

FIELD_BEFORE

FIELD_BRANCH

FIELD_CHANGE

FIELD_COMMENT

FIELD_COMMIT

FIELD_CONFLICTS

FIELD_DRAFTBY

FIELD_FILE

FIELD_IS

FIELD_HAS

FIELD_LABEL

FIELD_LIMIT

FIELD_MERGEABLE

FIELD_MESSAGE

FIELD_OWNER

FIELD_OWNERIN

FIELD_PARENTPROJECT

FIELD_PATH

FIELD_PROJECT

FIELD_REF

FIELD_REVIEWER

FIELD_REVIEWERIN

FIELD_STARREDBY

FIELD_STATUS

FIELD_TOPIC

FIELD_TR

FIELD_VISIBLETO

FIELD_WATCHEDBY

ARG_ID_USER

ARG_ID_GROUP

Constructor Detail

ChangeQueryBuilder

ChangeQueryBuilder

Method Detail

getLimit

hasNonTrivialSortKeyAfter

hasSortKey

age

before

until

after

since

change

comment

status

status_open

has

is

commit

conflicts

p

project

parentproject

branch

topic

ref

f

file

path

label

message

starredby

watchedby

draftby

visibleto

visibleto

is_visible

o

owner