com.google.gerrit.server.index.change

Class ChangeField

java.lang.Object

com.google.gerrit.server.index.change.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.

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 FieldDef<ChangeData,java.lang.Iterable<byte[]>>	APPROVAL Serialized approvals for the current patch set, used for pre-populating results.
static com.google.gwtorm.protobuf.ProtobufCodec<PatchSetApproval>	APPROVAL_CODEC
static FieldDef<ChangeData,java.lang.Integer>	ASSIGNEE The user assigned to the change.
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 FieldDef<ChangeData,byte[]>	CHANGE Serialized change object, used for pre-populating results.
static com.google.gwtorm.protobuf.ProtobufCodec<Change>	CHANGE_CODEC
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>>	DRAFTBY Users who have draft comments on 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.Iterable<byte[]>>	HASHTAG_CASE_AWARE Hashtags with original case.
static FieldDef<ChangeData,java.lang.String>	ID Newer style Change-Id key.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	LABEL Deprecated.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	LABEL2 List of labels on the current patch set including change owner votes.
static FieldDef<ChangeData,java.lang.Integer>	LEGACY_ID Legacy change ID.
static FieldDef<ChangeData,java.lang.String>	MERGEABLE Whether the change is mergeable.
static int	NO_ASSIGNEE
static java.lang.Integer	NOT_REVIEWED
static FieldDef<ChangeData,java.lang.Integer>	OWNER Owner/creator of the change.
static FieldDef<ChangeData,java.lang.Iterable<byte[]>>	PATCH_SET Serialized patch set object, used for pre-populating results.
static com.google.gwtorm.protobuf.ProtobufCodec<PatchSet>	PATCH_SET_CODEC
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<byte[]>>	REF_STATE All values of all refs that were used in the course of indexing this document.
static FieldDef<ChangeData,java.lang.Iterable<byte[]>>	REF_STATE_PATTERN All ref wildcard patterns that were used in the course of indexing this document.
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.String>>	REVIEWER Reviewer(s) associated with the change.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	STAR Star labels on this change in the format: <account-id>:<label>
static FieldDef<ChangeData,java.lang.Iterable<java.lang.Integer>>	STARBY Users that have starred the change with any label.
static FieldDef<ChangeData,java.lang.String>	STATUS Change status string, in the same format as status:.
static FieldDef<ChangeData,java.lang.Iterable<byte[]>>	STORED_SUBMIT_RECORD_LENIENT
static FieldDef<ChangeData,java.lang.Iterable<byte[]>>	STORED_SUBMIT_RECORD_STRICT
static FieldDef<ChangeData,java.lang.String>	SUBMISSIONID Submission id assigned by MergeOp.
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	SUBMIT_RECORD
static SubmitRuleOptions	SUBMIT_RULE_OPTIONS_LENIENT
static SubmitRuleOptions	SUBMIT_RULE_OPTIONS_STRICT
static FieldDef<ChangeData,java.lang.Iterable<java.lang.String>>	TR Tracking id extracted from a footer.
static FieldDef<ChangeData,java.lang.Integer>	UNRESOLVED_COMMENT_COUNT Number of unresolved comments of the change.
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, Account.Id accountId)
static java.util.List<java.lang.String>	formatSubmitRecordValues(ChangeData cd)
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)
static java.lang.String	getReviewerFieldValue(ReviewerStateInternal state, Account.Id id)
static ReviewerSet	parseReviewerFieldValues(java.lang.Iterable<java.lang.String> values)
static void	parseSubmitRecords(java.util.Collection<java.lang.String> values, SubmitRuleOptions opts, ChangeData out)

Methods inherited from class java.lang.Object

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

Field Detail

NO_ASSIGNEE

public static final int NO_ASSIGNEE

See Also:

Constant Field Values

LEGACY_ID

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

Legacy change ID.

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.

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

HASHTAG_CASE_AWARE

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> HASHTAG_CASE_AWARE

Hashtags with original case.

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.

ASSIGNEE

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

The user assigned to the change.

REVIEWER

public static final FieldDef<ChangeData,java.lang.Iterable<java.lang.String>> 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

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

Deprecated.

List of labels on the current patch set.

LABEL2

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

List of labels on the current patch set including change owner votes.

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_CODEC

public static final com.google.gwtorm.protobuf.ProtobufCodec<Change> CHANGE_CODEC

CHANGE

public static final FieldDef<ChangeData,byte[]> CHANGE

Serialized change object, used for pre-populating results.

APPROVAL_CODEC

public static final com.google.gwtorm.protobuf.ProtobufCodec<PatchSetApproval> APPROVAL_CODEC

APPROVAL

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> 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.

UNRESOLVED_COMMENT_COUNT

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

Number of unresolved comments of the change.

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.

STAR

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

Star labels on this change in the format: <account-id>:<label>

STARBY

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

Users that have starred the change with any label.

GROUP

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

Opaque group identifiers for this change's patch sets.

PATCH_SET_CODEC

public static final com.google.gwtorm.protobuf.ProtobufCodec<PatchSet> PATCH_SET_CODEC

PATCH_SET

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> 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.

DRAFTBY

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

Users who have draft comments on this change.

NOT_REVIEWED

public static final java.lang.Integer NOT_REVIEWED

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.

SUBMIT_RULE_OPTIONS_LENIENT

public static final SubmitRuleOptions SUBMIT_RULE_OPTIONS_LENIENT

SUBMIT_RULE_OPTIONS_STRICT

public static final SubmitRuleOptions SUBMIT_RULE_OPTIONS_STRICT

SUBMIT_RECORD

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

STORED_SUBMIT_RECORD_STRICT

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> STORED_SUBMIT_RECORD_STRICT

STORED_SUBMIT_RECORD_LENIENT

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> STORED_SUBMIT_RECORD_LENIENT

REF_STATE

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> REF_STATE

All values of all refs that were used in the course of indexing this document.

Emitted as UTF-8 encoded strings of the form project:ref/name:[hex sha].

REF_STATE_PATTERN

public static final FieldDef<ChangeData,java.lang.Iterable<byte[]>> REF_STATE_PATTERN

All ref wildcard patterns that were used in the course of indexing this document.

Emitted as UTF-8 encoded strings of the form project:ref/name/*. See StalenessChecker.RefStatePattern for the pattern format.

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

getReviewerFieldValue

public static java.lang.String getReviewerFieldValue(ReviewerStateInternal state,
                                                     Account.Id id)

parseReviewerFieldValues

public static ReviewerSet parseReviewerFieldValues(java.lang.Iterable<java.lang.String> values)

getAuthorParts

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

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException

getCommitterParts

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

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException

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,
                                           Account.Id accountId)

parseSubmitRecords

public static void parseSubmitRecords(java.util.Collection<java.lang.String> values,
                                      SubmitRuleOptions opts,
                                      ChangeData out)

formatSubmitRecordValues

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

Throws:

com.google.gwtorm.server.OrmException