com.couchbase.lite.internal.core

Class C4QueryEnumerator

java.lang.Object

com.couchbase.lite.internal.core.C4NativePeer

com.couchbase.lite.internal.core.C4QueryEnumerator

All Implemented Interfaces:

AutoCloseable

public class C4QueryEnumerator
extends C4NativePeer

C4QueryEnumerator A query result enumerator Created by c4db_query. Must be freed with c4queryenum_free. The fields of this struct represent the current matched index row. They are valid until the next call to c4queryenum_next or c4queryenum_free.

Method Summary

Modifier and Type	Method and Description
void	close()
C4QueryEnumerator	copy() Returns a new Java instance referring to the same underlying C object.
FLArrayIterator	getColumns() FLArrayIterator columns The columns of this result, in the same order as in the query's `WHAT` clause.
long	getMissingColumns() Returns a bitmap in which a 1 bit represents a column whose value is MISSING.
long	getRowCount()
boolean	next()
C4QueryEnumerator	refresh()
boolean	seek(long rowIndex)

Methods inherited from class com.couchbase.lite.internal.core.C4NativePeer

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

next

public boolean next()
             throws LiteCoreException

Throws:

LiteCoreException

getRowCount

public long getRowCount()
                 throws LiteCoreException

Throws:

LiteCoreException

refresh

@Nullable
public C4QueryEnumerator refresh()
                                    throws LiteCoreException

Throws:

LiteCoreException

getColumns

@NonNull
public FLArrayIterator getColumns()

FLArrayIterator columns The columns of this result, in the same order as in the query's `WHAT` clause. NOTE: FLArrayIterator is member variable of C4QueryEnumerator. Not necessary to release.

getMissingColumns

public long getMissingColumns()

Returns a bitmap in which a 1 bit represents a column whose value is MISSING. This is how you tell a missing property value from a value that is JSON 'null', since the value in the `columns` array will be a Fleece `null` either way.

copy

@NonNull
public C4QueryEnumerator copy()

Returns a new Java instance referring to the same underlying C object.

Returns:

the Java-level copy

close

@CallSuper
public void close()

seek

public boolean seek(long rowIndex)
             throws LiteCoreException

Throws:

LiteCoreException