com.google.gerrit.server.index

Class ChangeField

java.lang.Object

com.google.gerrit.server.index.ChangeField

public class ChangeField
extends java.lang.Object

Fields indexed on change documents.

Each field corresponds to both a field name supported by ChangeQueryBuilder for querying that field, and a method on ChangeData used for populating the corresponding document fields in the secondary index.

Field names are all lowercase alphanumeric plus underscore; index implementations may create unambiguous derived field names containing other characters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangeField.ChangeProtoField
static class	ChangeField.PatchSetApprovalProtoField
static class	ChangeField.PatchSetProtoField

Field Summary

Fields

Modifier and Type	Field and Description
static FieldDef<ChangeData,java.lang.Integer>	ADDED The number of inserted lines in this change.
static ChangeField.PatchSetApprovalProtoField	APPROVAL Serialized approvals for the current patch set, used for pre-populating results.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	AUTHOR The exact email address, or any part of the author name or email address, in the current patch set.
static ChangeField.ChangeProtoField	CHANGE Serialized change object, used for pre-populating results.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	COMMENT Summary or inline comment.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>>	COMMENTBY Users who have commented on this change.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	COMMIT Commit ID of any patch set on the change, using prefix match.
static FieldDef<ChangeData,java.lang.String>	COMMIT_MESSAGE Commit message of the current patch set.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	COMMITTER The exact email address, or any part of the committer name or email address, in the current patch set.
static FieldDef<ChangeData,java.lang.Integer>	DELETED The number of deleted lines in this change.
static FieldDef<ChangeData,java.lang.Integer>	DELTA The total number of modified lines in this change.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>>	EDITBY Users who have edits on this change.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	EXACT_COMMIT Commit ID of any patch set on the change, using exact match.
static FieldDef<ChangeData,java.lang.String>	EXACT_TOPIC Topic, a short annotation on the branch.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	FILE_PART Components of each file path modified in the current patch set.
static FieldDef<ChangeData,java.lang.String>	FUZZY_TOPIC Topic, a short annotation on the branch.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	GROUP Opaque group identifiers for this change's patch sets.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	HASHTAG Hashtags tied to a change
static FieldDef<ChangeData,java.lang.String>	ID Newer style Change-Id key.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	LABEL List of labels on the current patch set.
static FieldDef<ChangeData,java.lang.Integer>	LEGACY_ID Deprecated.
static FieldDef<ChangeData,java.lang.Integer>	LEGACY_ID2 Legacy change ID without underscore prefix.
static FieldDef<ChangeData,java.lang.String>	LEGACY_REVIEWED Deprecated.
static FieldDef<ChangeData,java.lang.String>	LEGACY_TOPIC2 Deprecated.
static FieldDef<ChangeData,java.lang.String>	LEGACY_TOPIC3 Deprecated.
static FieldDef<ChangeData,java.lang.String>	MERGEABLE Whether the change is mergeable.
static java.lang.Integer	NOT_REVIEWED
static FieldDef<ChangeData,java.lang.Integer>	OWNER Owner/creator of the change.
static ChangeField.PatchSetProtoField	PATCH_SET Serialized patch set object, used for pre-populating results.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	PATH List of full file paths modified in the current patch set.
static FieldDef<ChangeData,java.lang.String>	PROJECT Project containing the change.
static FieldDef<ChangeData,java.lang.String>	PROJECTS Project containing the change, as a prefix field.
static FieldDef<ChangeData,java.lang.String>	REF Reference (aka branch) the change will submit onto.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>>	REVIEWEDBY Users the change was reviewed by since the last author update.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>>	REVIEWER Reviewer(s) associated with the change.
static FieldDef<ChangeData,java.lang.String>	STATUS Change status string, in the same format as status:.
static FieldDef<ChangeData,java.lang.String>	SUBMISSIONID Submission id assigned by MergeOp.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	TR Tracking id extracted from a footer.
static FieldDef<ChangeData,java.sql.Timestamp>	UPDATED Last update time since January 1, 1970.

Constructor Summary

Constructors

Constructor and Description
ChangeField()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatLabel(java.lang.String label, int value)
static java.lang.String	formatLabel(java.lang.String label, int value, com.google.gerrit.reviewdb.client.Account.Id accountId)
static java.util.Set<java.lang.String>	getAuthorParts(ChangeData cd)
static java.util.Set<java.lang.String>	getCommitterParts(ChangeData cd)
static java.util.Set<java.lang.String>	getFileParts(ChangeData cd)

Methods inherited from class java.lang.Object

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

Field Detail

LEGACY_ID

@Deprecated
public static final FieldDef<ChangeData,java.lang.Integer> LEGACY_ID

Deprecated.

LEGACY_ID2

public static final FieldDef<ChangeData,java.lang.Integer> LEGACY_ID2

Legacy change ID without underscore prefix.

ID

public static final FieldDef<ChangeData,java.lang.String> ID

Newer style Change-Id key.

STATUS

public static final FieldDef<ChangeData,java.lang.String> STATUS

Change status string, in the same format as status:.

PROJECT

public static final FieldDef<ChangeData,java.lang.String> PROJECT

Project containing the change.

PROJECTS

public static final FieldDef<ChangeData,java.lang.String> PROJECTS

Project containing the change, as a prefix field.

REF

public static final FieldDef<ChangeData,java.lang.String> REF

Reference (aka branch) the change will submit onto.

LEGACY_TOPIC2

@Deprecated
public static final FieldDef<ChangeData,java.lang.String> LEGACY_TOPIC2

Deprecated.

LEGACY_TOPIC3

@Deprecated
public static final FieldDef<ChangeData,java.lang.String> LEGACY_TOPIC3

Deprecated.

EXACT_TOPIC

public static final FieldDef<ChangeData,java.lang.String> EXACT_TOPIC

Topic, a short annotation on the branch.

FUZZY_TOPIC

public static final FieldDef<ChangeData,java.lang.String> FUZZY_TOPIC

Topic, a short annotation on the branch.

SUBMISSIONID

public static final FieldDef<ChangeData,java.lang.String> SUBMISSIONID

Submission id assigned by MergeOp.

UPDATED

public static final FieldDef<ChangeData,java.sql.Timestamp> UPDATED

Last update time since January 1, 1970.

PATH

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> PATH

List of full file paths modified in the current patch set.

HASHTAG

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> HASHTAG

Hashtags tied to a change

FILE_PART

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> FILE_PART

Components of each file path modified in the current patch set.

OWNER

public static final FieldDef<ChangeData,java.lang.Integer> OWNER

Owner/creator of the change.

REVIEWER

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>> REVIEWER

Reviewer(s) associated with the change.

COMMIT

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> COMMIT

Commit ID of any patch set on the change, using prefix match.

EXACT_COMMIT

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> EXACT_COMMIT

Commit ID of any patch set on the change, using exact match.

TR

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> TR

Tracking id extracted from a footer.

LABEL

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> LABEL

List of labels on the current patch set.

LEGACY_REVIEWED

@Deprecated
public static final FieldDef<ChangeData,java.lang.String> LEGACY_REVIEWED

Deprecated.

Set true if the change has a non-zero label score.

AUTHOR

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> AUTHOR

The exact email address, or any part of the author name or email address, in the current patch set.

COMMITTER

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> COMMITTER

The exact email address, or any part of the committer name or email address, in the current patch set.

CHANGE

public static final ChangeField.ChangeProtoField CHANGE

Serialized change object, used for pre-populating results.

APPROVAL

public static final ChangeField.PatchSetApprovalProtoField APPROVAL

Serialized approvals for the current patch set, used for pre-populating results.

COMMIT_MESSAGE

public static final FieldDef<ChangeData,java.lang.String> COMMIT_MESSAGE

Commit message of the current patch set.

COMMENT

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> COMMENT

Summary or inline comment.

MERGEABLE

public static final FieldDef<ChangeData,java.lang.String> MERGEABLE

Whether the change is mergeable.

ADDED

public static final FieldDef<ChangeData,java.lang.Integer> ADDED

The number of inserted lines in this change.

DELETED

public static final FieldDef<ChangeData,java.lang.Integer> DELETED

The number of deleted lines in this change.

DELTA

public static final FieldDef<ChangeData,java.lang.Integer> DELTA

The total number of modified lines in this change.

COMMENTBY

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>> COMMENTBY

Users who have commented on this change.

GROUP

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> GROUP

Opaque group identifiers for this change's patch sets.

PATCH_SET

public static final ChangeField.PatchSetProtoField PATCH_SET

Serialized patch set object, used for pre-populating results.

EDITBY

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>> EDITBY

Users who have edits on this change.

REVIEWEDBY

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>> REVIEWEDBY

Users the change was reviewed by since the last author update.

A change is considered reviewed by a user if the latest update by that user is newer than the latest update by the change author. Both top-level change messages and new patch sets are considered to be updates.

If the latest update is by the change owner, then the special value NOT_REVIEWED is emitted.

NOT_REVIEWED

public static final java.lang.Integer NOT_REVIEWED

Constructor Detail

ChangeField

public ChangeField()

Method Detail

getFileParts

public static java.util.Set<java.lang.String> getFileParts(ChangeData cd)
                                                    throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

getAuthorParts

public static java.util.Set<java.lang.String> getAuthorParts(ChangeData cd)
                                                      throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

getCommitterParts

public static java.util.Set<java.lang.String> getCommitterParts(ChangeData cd)
                                                         throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

formatLabel

public static java.lang.String formatLabel(java.lang.String label,
                                           int value)

formatLabel

public static java.lang.String formatLabel(java.lang.String label,
                                           int value,
                                           com.google.gerrit.reviewdb.client.Account.Id accountId)