com.couchbase.lite.store

Class SQLiteViewStore

java.lang.Object

com.couchbase.lite.store.SQLiteViewStore

All Implemented Interfaces:

QueryRowStore, ViewStore

public class SQLiteViewStore
extends java.lang.Object
implements ViewStore, QueryRowStore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLiteViewStore(SQLiteStore store, java.lang.String name, boolean create)

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
protected void	emit(java.lang.Object key, java.lang.Object value, long sequence)
ViewStoreDelegate	getDelegate() The delegate (in practice, the owning View itself.)
java.util.Map<java.lang.String,java.lang.Object>	getDocumentProperties(java.lang.String docID, long sequence) Fetches a document's body; called when the row value represents the entire document.
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.
static java.lang.Object	groupKey(java.lang.Object key, int groupLevel) Returns the prefix of the key to use in the result row, at this groupLevel
java.lang.Object	parseRowValue(byte[] valueData) Parses a "normal" (not entire-doc) row value into a JSON-compatible object.
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.
boolean	rowValueIsEntireDoc(byte[] valueData) Given the raw data of a row's value, returns YES if this is a non-JSON placeholder representing the entire document.
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> inputViews) Updates the indexes of one or more views in parallel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static java.lang.String TAG

Constructor Detail

SQLiteViewStore

protected SQLiteViewStore(SQLiteStore store,
                          java.lang.String name,
                          boolean create)
                   throws CouchbaseLiteException

Throws:

CouchbaseLiteException

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ViewStore

The name of the view.

Specified by:

getName in interface ViewStore

getDelegate

public ViewStoreDelegate getDelegate()

Description copied from interface: ViewStore

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

Specified by:

getDelegate in interface ViewStore

setDelegate

public void setDelegate(ViewStoreDelegate delegate)

Specified by:

setDelegate in interface ViewStore

setCollation

public void setCollation(View.TDViewCollation collation)

Specified by:

setCollation in interface ViewStore

close

public void close()

Description copied from interface: ViewStore

Closes the storage.

Specified by:

close in interface ViewStore

deleteIndex

public void deleteIndex()

Description copied from interface: ViewStore

Erases the view's _index.

Specified by:

deleteIndex in interface ViewStore

deleteView

public void deleteView()

Description copied from interface: ViewStore

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

Specified by:

deleteView in interface ViewStore

setVersion

public 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.

Specified by:

setVersion in interface ViewStore

getTotalRows

public int getTotalRows()

Description copied from interface: ViewStore

The total number of rows in the _index.

Specified by:

getTotalRows in interface ViewStore

getLastSequenceIndexed

public long getLastSequenceIndexed()

The last sequence number that has been indexed.

Specified by:

getLastSequenceIndexed in interface ViewStore

getLastSequenceChangedAt

public long getLastSequenceChangedAt()

Description copied from interface: ViewStore

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

Specified by:

getLastSequenceChangedAt in interface ViewStore

updateIndexes

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

Updates the indexes of one or more views in parallel.

Specified by:

updateIndexes in interface ViewStore

Parameters:

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

Returns:

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

Throws:

CouchbaseLiteException

emit

protected void emit(java.lang.Object key,
                    java.lang.Object value,
                    long sequence)
             throws JsonProcessingException

Throws:

JsonProcessingException

regularQuery

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

Queries the view without performing any reducing or grouping.

Specified by:

regularQuery in interface ViewStore

Throws:

CouchbaseLiteException

reducedQuery

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

Queries the view, with reducing or grouping as per the options. in CBL_SQLiteViewStorage.m - (CBLQueryIteratorBlock) reducedQueryWithOptions: (CBLQueryOptions*)options status: (CBLStatus*)outStatus

Specified by:

reducedQuery in interface ViewStore

Throws:

CouchbaseLiteException

dump

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

Description copied from interface: ViewStore

Methods for debugging

Specified by:

dump in interface ViewStore

rowValueIsEntireDoc

public boolean rowValueIsEntireDoc(byte[] valueData)

Description copied from interface: QueryRowStore

Given the raw data of a row's value, returns YES if this is a non-JSON placeholder representing the entire document. If so, the CBLQueryRow will not parse this data but will instead fetch the document's body from the database and use that as its value.

Specified by:

rowValueIsEntireDoc in interface QueryRowStore

parseRowValue

public java.lang.Object parseRowValue(byte[] valueData)

Description copied from interface: QueryRowStore

Parses a "normal" (not entire-doc) row value into a JSON-compatible object.

Specified by:

parseRowValue in interface QueryRowStore

getDocumentProperties

public java.util.Map<java.lang.String,java.lang.Object> getDocumentProperties(java.lang.String docID,
                                                                              long sequence)

Description copied from interface: QueryRowStore

Fetches a document's body; called when the row value represents the entire document.

Specified by:

getDocumentProperties in interface QueryRowStore

Parameters:

docID - The document ID

sequence - The sequence representing this revision

Returns:

The document properties, or nil on error

groupKey

public static java.lang.Object groupKey(java.lang.Object key,
                                        int groupLevel)

Returns the prefix of the key to use in the result row, at this groupLevel