com.couchbase.lite.store

Interface ViewStore

All Known Implementing Classes:

SQLiteViewStore

public interface ViewStore

Storage for a view. Instances are created by Storage implementations, and are owned by View instances.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the storage.
void	deleteIndex() Erases the view's _index.
void	deleteView() Deletes the view's storage (metadata and _index), removing it from the database.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	dump() Methods for debugging
ViewStoreDelegate	getDelegate() The delegate (in practice, the owning View itself.)
long	getLastSequenceChangedAt() The last sequence number that caused an actual change in the _index.
long	getLastSequenceIndexed() The last sequence number that has been indexed.
java.lang.String	getName() The name of the view.
int	getTotalRows() The total number of rows in the _index.
java.util.List<QueryRow>	reducedQuery(QueryOptions options) Queries the view, with reducing or grouping as per the options.
java.util.List<QueryRow>	regularQuery(QueryOptions options) Queries the view without performing any reducing or grouping.
void	setCollation(View.TDViewCollation collation)
void	setDelegate(ViewStoreDelegate delegate)
boolean	setVersion(java.lang.String version) Updates the version of the view.
Status	updateIndexes(java.util.List<ViewStore> views) Updates the indexes of one or more views in parallel.

Method Detail

getName

java.lang.String getName()

The name of the view.

getDelegate

ViewStoreDelegate getDelegate()

The delegate (in practice, the owning View itself.)

setDelegate

void setDelegate(ViewStoreDelegate delegate)

close

void close()

Closes the storage.

deleteIndex

void deleteIndex()

Erases the view's _index.

deleteView

void deleteView()

Deletes the view's storage (metadata and _index), removing it from the database.

setVersion

boolean setVersion(java.lang.String version)

Updates the version of the view. A change in version means the delegate's map block has changed its semantics, so the _index should be deleted.

getTotalRows

int getTotalRows()

The total number of rows in the _index.

getLastSequenceIndexed

long getLastSequenceIndexed()

The last sequence number that has been indexed.

getLastSequenceChangedAt

long getLastSequenceChangedAt()

The last sequence number that caused an actual change in the _index.

updateIndexes

Status updateIndexes(java.util.List<ViewStore> views)
              throws CouchbaseLiteException

Updates the indexes of one or more views in parallel.

Parameters:

views - An array of ViewStore instances, always including the receiver.

Returns:

Status OK if updated or NOT_MODIFIED if already up-to-date.

Throws:

CouchbaseLiteException

regularQuery

java.util.List<QueryRow> regularQuery(QueryOptions options)
                               throws CouchbaseLiteException

Queries the view without performing any reducing or grouping.

Throws:

CouchbaseLiteException

reducedQuery

java.util.List<QueryRow> reducedQuery(QueryOptions options)
                               throws CouchbaseLiteException

Queries the view, with reducing or grouping as per the options.

Throws:

CouchbaseLiteException

dump

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> dump()

Methods for debugging

setCollation

void setCollation(View.TDViewCollation collation)