JdbcAccountPatchReviewStore (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.schema.JdbcAccountPatchReviewStore

All Implemented Interfaces:

com.google.gerrit.extensions.events.LifecycleListener, AccountPatchReviewStore, EventListener

Direct Known Subclasses:

H2AccountPatchReviewStore, MysqlAccountPatchReviewStore, PostgresqlAccountPatchReviewStore
```
public abstract class JdbcAccountPatchReviewStore
extends Object
implements AccountPatchReviewStore, com.google.gerrit.extensions.events.LifecycleListener
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JdbcAccountPatchReviewStore.Module
- Nested classes/interfaces inherited from interface com.google.gerrit.server.change.AccountPatchReviewStore
  AccountPatchReviewStore.PatchSetWithReviewedFiles

Nested Classes
Modifier and Type	Class and Description
`static class`	`JdbcAccountPatchReviewStore.Module`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`JdbcAccountPatchReviewStore(org.eclipse.jgit.lib.Config cfg, SitePaths sitePaths)`
`protected`	`JdbcAccountPatchReviewStore(DataSource ds)`

Method Summary

Methods
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, String path)` Clears the reviewed flag for the given file in the given patch set for the given user.
`com.google.gwtorm.server.OrmException`	`convertError(String op, SQLException err)`
`static JdbcAccountPatchReviewStore`	`createAccountPatchReviewStore(org.eclipse.jgit.lib.Config cfg, SitePaths sitePaths)`
`protected static DataSource`	`createDataSource(String url)`
`void`	`createTableIfNotExists()`
`void`	`dropTableIfExists()`
`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.
`Connection`	`getConnection()`
`protected static int`	`getSQLStateInt(SQLException err)`
`void`	`markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId, com.google.gerrit.reviewdb.client.Account.Id accountId, Collection<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, String path)` Marks the given file in the given patch set as reviewed by the given user.
`void`	`start()`
`void`	`stop()`

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

- Constructor Detail
  - JdbcAccountPatchReviewStore
```
protected JdbcAccountPatchReviewStore(org.eclipse.jgit.lib.Config cfg,
                           SitePaths sitePaths)
```
  - JdbcAccountPatchReviewStore
```
protected JdbcAccountPatchReviewStore(DataSource ds)
```
- Method Detail
  - createAccountPatchReviewStore
```
public static JdbcAccountPatchReviewStore createAccountPatchReviewStore(org.eclipse.jgit.lib.Config cfg,
                                                        SitePaths sitePaths)
```
  - createDataSource
```
protected static DataSource createDataSource(String url)
```
  - start
```
public void start()
```
    Specified by:
    
    start in interface com.google.gerrit.extensions.events.LifecycleListener
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Throws:
    
    SQLException
  - createTableIfNotExists
```
public void createTableIfNotExists()
                            throws com.google.gwtorm.server.OrmException
```
    Throws:
    
    com.google.gwtorm.server.OrmException
  - dropTableIfExists
```
public void dropTableIfExists()
                       throws com.google.gwtorm.server.OrmException
```
    Throws:
    
    com.google.gwtorm.server.OrmException
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface com.google.gerrit.extensions.events.LifecycleListener
  - markReviewed
```
public boolean markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                   com.google.gerrit.reviewdb.client.Account.Id accountId,
                   String path)
                     throws com.google.gwtorm.server.OrmException
```
    Description copied from interface: AccountPatchReviewStore
    
    Marks the given file in the given patch set as reviewed by the given user.
    
    Specified by:
    
    markReviewed in interface AccountPatchReviewStore
    
    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
```
public void markReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                com.google.gerrit.reviewdb.client.Account.Id accountId,
                Collection<String> paths)
                  throws com.google.gwtorm.server.OrmException
```
    Description copied from interface: AccountPatchReviewStore
    
    Marks the given files in the given patch set as reviewed by the given user.
    
    Specified by:
    
    markReviewed in interface AccountPatchReviewStore
    
    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
```
public void clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId,
                 com.google.gerrit.reviewdb.client.Account.Id accountId,
                 String path)
                   throws com.google.gwtorm.server.OrmException
```
    Description copied from interface: AccountPatchReviewStore
    
    Clears the reviewed flag for the given file in the given patch set for the given user.
    
    Specified by:
    
    clearReviewed in interface AccountPatchReviewStore
    
    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
```
public void clearReviewed(com.google.gerrit.reviewdb.client.PatchSet.Id psId)
                   throws com.google.gwtorm.server.OrmException
```
    Description copied from interface: AccountPatchReviewStore
    
    Clears the reviewed flags for all files in the given patch set for all users.
    
    Specified by:
    
    clearReviewed in interface AccountPatchReviewStore
    
    Parameters:
    psId - patch set ID
    
    Throws:
    
    com.google.gwtorm.server.OrmException - thrown if clearing the reviewed flags failed
  - findReviewed
```
public 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
```
    Description copied from interface: AccountPatchReviewStore
    
    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.
    
    Specified by:
    
    findReviewed in interface AccountPatchReviewStore
    
    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
  - convertError
```
public com.google.gwtorm.server.OrmException convertError(String op,
                                                 SQLException err)
```
  - getSQLStateInt
```
protected static int getSQLStateInt(SQLException err)
```

Class JdbcAccountPatchReviewStore

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.server.change.AccountPatchReviewStore

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JdbcAccountPatchReviewStore

JdbcAccountPatchReviewStore

Method Detail

createAccountPatchReviewStore

createDataSource

start

getConnection

createTableIfNotExists

dropTableIfExists

stop

markReviewed

markReviewed

clearReviewed

clearReviewed

findReviewed

convertError

getSQLStateInt