DummyIndex (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.index.DummyIndex

All Implemented Interfaces:: ChangeIndex

public class DummyIndex
extends java.lang.Object
implements ChangeIndex

Constructor Summary

Constructors
Constructor and Description

DummyIndex()

Constructors
Constructor and Description
`DummyIndex()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close this index.
`void`	`delete(com.google.gerrit.reviewdb.client.Change.Id id)` Delete a change document from the index by id.
`void`	`deleteAll()` Delete all change documents from the index.
`int`	`getMaxLimit()`
`Schema<ChangeData>`	`getSchema()`
`ChangeDataSource`	`getSource(Predicate<ChangeData> p, QueryOptions opts)` Convert the given operator predicate into a source searching the index and returning only the documents matching that predicate.
`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.

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

- Constructor Detail
  - DummyIndex
```
public DummyIndex()
```
- Method Detail
  - getSchema
```
public Schema<ChangeData> getSchema()
```
    Specified by:
    
    getSchema in interface ChangeIndex
    
    Returns:
    the schema version used by this index.
  - close
```
public void close()
```
    Description copied from interface: ChangeIndex
    
    Close this index.
    
    Specified by:
    
    close in interface ChangeIndex
  - replace
```
public void replace(ChangeData cd)
             throws java.io.IOException
```
    Description copied from interface: ChangeIndex
    
    Update a change document in the index.
    Semantically equivalent to deleting the document and reinserting it with new field values. A document that does not already exist is created. Results may not be immediately visible to searchers, but should be visible within a reasonable amount of time.
    
    Specified by:
    
    replace in interface ChangeIndex
    
    Parameters:
    cd - change document
    
    Throws:
    
    java.io.IOException
  - delete
```
public void delete(com.google.gerrit.reviewdb.client.Change.Id id)
            throws java.io.IOException
```
    Description copied from interface: ChangeIndex
    
    Delete a change document from the index by id.
    
    Specified by:
    
    delete in interface ChangeIndex
    
    Parameters:
    id - change id
    
    Throws:
    
    java.io.IOException
  - deleteAll
```
public void deleteAll()
               throws java.io.IOException
```
    Description copied from interface: ChangeIndex
    
    Delete all change documents from the index.
    
    Specified by:
    
    deleteAll in interface ChangeIndex
    
    Throws:
    
    java.io.IOException
  - getSource
```
public ChangeDataSource getSource(Predicate<ChangeData> p,
                         QueryOptions opts)
```
    Description copied from interface: ChangeIndex
    
    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).
    
    Specified by:
    
    getSource in interface ChangeIndex
    
    Parameters:
    p - the predicate to match. Must be a tree containing only AND, OR, or NOT predicates as internal nodes, and IndexPredicates as leaves.
    opts - query options not implied by the predicate, such as start and limit.
    
    Returns:
    a source of documents matching the predicate. Documents must be returned in descending updated timestamp order.
  - markReady
```
public void markReady(boolean ready)
               throws java.io.IOException
```
    Description copied from interface: ChangeIndex
    
    Mark whether this index is up-to-date and ready to serve reads.
    
    Specified by:
    
    markReady in interface ChangeIndex
    
    Parameters:
    ready - whether the index is ready
    
    Throws:
    
    java.io.IOException
  - getMaxLimit
```
public int getMaxLimit()
```

Class DummyIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DummyIndex

Method Detail

getSchema

close

replace

delete

deleteAll

getSource

markReady

getMaxLimit