com.google.gerrit.server.change

Interface AccountPatchReviewStore

All Known Implementing Classes:

H2AccountPatchReviewStore, JdbcAccountPatchReviewStore, MysqlAccountPatchReviewStore, PostgresqlAccountPatchReviewStore

public interface AccountPatchReviewStore

Store for reviewed flags on changes. A reviewed flag is a tuple of (patch set ID, file, account ID) and records whether the user has reviewed a file in a patch set. Each user can easily have thousands of reviewed flags and the number of reviewed flags is growing without bound. The store must be able handle this data volume efficiently. For a multi-master setup the store must replicate the data between the masters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AccountPatchReviewStore.PatchSetWithReviewedFiles Represents patch set id with reviewed files.

Method Summary

Modifier and Type	Method and Description
void	clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId) Clears the reviewed flags for all files in the given patch set for all users.
void	clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId, com.google.gerrit.reviewdb.client.Account.Id accountId, java.lang.String path) Clears the reviewed flag for the given file in the given patch set for the given user.
com.google.common.base.Optional<AccountPatchReviewStore.PatchSetWithReviewedFiles>	findReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId, com.google.gerrit.reviewdb.client.Account.Id accountId) Find the latest patch set, that is smaller or equals to the given patch set, where at least, one file has been reviewed by the given user.
void	markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId, com.google.gerrit.reviewdb.client.Account.Id accountId, java.util.Collection<java.lang.String> paths) Marks the given files in the given patch set as reviewed by the given user.
boolean	markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId, com.google.gerrit.reviewdb.client.Account.Id accountId, java.lang.String path) Marks the given file in the given patch set as reviewed by the given user.

Method Detail

markReviewed

boolean markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                     com.google.gerrit.reviewdb.client.Account.Id accountId,
                     java.lang.String path)
              throws com.google.gwtorm.server.OrmException

Marks the given file in the given patch set as reviewed by the given user.

Parameters:

psId - patch set ID

accountId - account ID of the user

path - file path

Returns:

true if the reviewed flag was updated, false if the reviewed flag was already set

Throws:

com.google.gwtorm.server.OrmException - thrown if updating the reviewed flag failed

markReviewed

void markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                  com.google.gerrit.reviewdb.client.Account.Id accountId,
                  java.util.Collection<java.lang.String> paths)
           throws com.google.gwtorm.server.OrmException

Marks the given files in the given patch set as reviewed by the given user.

Parameters:

psId - patch set ID

accountId - account ID of the user

paths - file paths

Throws:

com.google.gwtorm.server.OrmException - thrown if updating the reviewed flag failed

clearReviewed

void clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                   com.google.gerrit.reviewdb.client.Account.Id accountId,
                   java.lang.String path)
            throws com.google.gwtorm.server.OrmException

Clears the reviewed flag for the given file in the given patch set for the given user.

Parameters:

psId - patch set ID

accountId - account ID of the user

path - file path

Throws:

com.google.gwtorm.server.OrmException - thrown if clearing the reviewed flag failed

clearReviewed

void clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId)
            throws com.google.gwtorm.server.OrmException

Clears the reviewed flags for all files in the given patch set for all users.

Parameters:

psId - patch set ID

Throws:

com.google.gwtorm.server.OrmException - thrown if clearing the reviewed flags failed

findReviewed

com.google.common.base.Optional<AccountPatchReviewStore.PatchSetWithReviewedFiles> findReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                                                                                                com.google.gerrit.reviewdb.client.Account.Id accountId)
                                                                                         throws com.google.gwtorm.server.OrmException

Find the latest patch set, that is smaller or equals to the given patch set, where at least, one file has been reviewed by the given user.

Parameters:

psId - patch set ID

accountId - account ID of the user

Returns:

optionally, all files the have been reviewed by the given user that belong to the patch set that is smaller or equals to the given patch set

Throws:

com.google.gwtorm.server.OrmException - thrown if accessing the reviewed flags failed