ChangeIndex (Gerrit Review Plugin API Documentation)

All Known Implementing Classes:

DummyIndex
```
public interface ChangeIndex
```
Secondary index implementation for change documents.
ChangeData objects are inserted into the index and are queried by converting special Predicate instances into index-aware predicates that use the index search results as a source.
Implementations must be thread-safe and should batch inserts/updates where appropriate.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close this index.
`void`	`delete(ChangeData cd)` Delete a change document from the index.
`void`	`delete(int id)` Delete a change document from the index by id.
`void`	`deleteAll()` Delete all change documents from the index.
`Schema<ChangeData>`	`getSchema()`
`ChangeDataSource`	`getSource(Predicate<ChangeData> p, int start, int limit)` Convert the given operator predicate into a source searching the index and returning only the documents matching that predicate.
`void`	`insert(ChangeData cd)` Insert a change document into the index.
`void`	`markReady(boolean ready)` Mark whether this index is up-to-date and ready to serve reads.
`void`	`replace(ChangeData cd)` Update a change document in the index.

- Method Detail
  - getSchema
```
Schema<ChangeData> getSchema()
```
    Returns:
    the schema version used by this index.
  - close
```
void close()
```
    Close this index.
  - insert
```
void insert(ChangeData cd)
            throws java.io.IOException
```
    Insert a change document into the index.
    Results may not be immediately visible to searchers, but should be visible within a reasonable amount of time.
    
    Parameters:
    cd - change document
    
    Throws:
    
    java.io.IOException - if the change could not be inserted.
  - replace
```
void replace(ChangeData cd)
             throws java.io.IOException
```
    Update a change document in the index.
    Semantically equivalent to deleting the document and reinserting it with new field values. Results may not be immediately visible to searchers, but should be visible within a reasonable amount of time.
    
    Parameters:
    cd - change document
    
    Throws:
    
    java.io.IOException
  - delete
```
void delete(ChangeData cd)
            throws java.io.IOException
```
    Delete a change document from the index.
    
    Parameters:
    cd - change document
    
    Throws:
    
    java.io.IOException
  - delete
```
void delete(int id)
            throws java.io.IOException
```
    Delete a change document from the index by id.
    
    Parameters:
    id - change document id
    
    Throws:
    
    java.io.IOException
  - deleteAll
```
void deleteAll()
               throws java.io.IOException
```
    Delete all change documents from the index.
    
    Throws:
    
    java.io.IOException
  - getSource
```
ChangeDataSource getSource(Predicate<ChangeData> p,
                         int start,
                         int limit)
                           throws com.google.gerrit.server.query.QueryParseException
```
    Convert the given operator predicate into a source searching the index and returning only the documents matching that predicate.
    This method may be called multiple times for variations on the same predicate or multiple predicate subtrees in the course of processing a single query, so it should not have any side effects (e.g. starting a search in the background).
    
    Parameters:
    p - the predicate to match. Must be a tree containing only AND, OR, or NOT predicates as internal nodes, and IndexPredicates as leaves.
    start - offset in results list at which to start returning results.
    limit - maximum number of results to return.
    
    Returns:
    a source of documents matching the predicate. Documents must be returned in descending sort key order, unless a sortkey_after predicate (with a cut point not at Long.MAX_VALUE) is provided, in which case the source should return documents in ascending sort key order starting from the sort key cut point.
    
    Throws:
    
    com.google.gerrit.server.query.QueryParseException - if the predicate could not be converted to an indexed data source.
  - markReady
```
void markReady(boolean ready)
               throws java.io.IOException
```
    Mark whether this index is up-to-date and ready to serve reads.
    
    Parameters:
    ready - whether the index is ready
    
    Throws:
    
    java.io.IOException

Interface ChangeIndex

Method Summary

Method Detail

getSchema

close

insert

replace

delete

delete

deleteAll

getSource

markReady