com.couchbase.client.java.view

Interface AsyncViewRow

All Known Implementing Classes:

DefaultAsyncViewRow

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface AsyncViewRow

Represents a row fetched from the View.

The row itself contains fixed properties returned, but is also able to - on demand - load the full document if instructed through the document() methods.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
rx.Observable<JsonDocument>	document() Load the underlying document, if not reduced.
<D extends Document<?>> rx.Observable<D>	document(java.lang.Class<D> target) Load the underlying document, if not reduced.
java.lang.String	id() The id of the document, if not reduced.
java.lang.Object	key() The key of the row index.
java.lang.Object	value() The value of the row index.

Method Detail

id

java.lang.String id()

The id of the document, if not reduced.

Returns:

the id of the document.

key

java.lang.Object key()

The key of the row index.

The object can be any valid JSON object, including JsonArray or JsonObject.

Returns:

the key.

value

java.lang.Object value()

The value of the row index.

The object can be any valid JSON object, including JsonArray or JsonObject.

Returns:

the value.

document

rx.Observable<JsonDocument> document()

Load the underlying document, if not reduced.

The Observable can error under the following conditions:

• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
• java.lang.IllegalStateException: If the view is reduced and the ID is null.
• com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.

Returns:

a Observable containing the document once loaded.

document

<D extends Document<?>> rx.Observable<D> document(java.lang.Class<D> target)

Load the underlying document, if not reduced.

The Observable can error under the following conditions:

• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
• java.lang.IllegalStateException: If the view is reduced and the ID is null.
• com.couchbase.client.java.error.TranscodingException: If the response document could not be decoded.

Parameters:

target - the target class to decode into.

Returns:

a Observable containing the document once loaded.