com.couchbase.client.java.view

Interface ViewRow

All Known Implementing Classes:

DefaultViewRow

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface ViewRow

Represents a ViewRow fetched from the View.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
JsonDocument	document() Load the underlying document, if not reduced with the default view timeout.
<D extends Document<?>> D	document(java.lang.Class<D> target) Load the underlying document, if not reduced with the default view timeout.
<D extends Document<?>> D	document(java.lang.Class<D> target, long timeout, java.util.concurrent.TimeUnit timeUnit) Load the underlying document, if not reduced with a custom timeout.
JsonDocument	document(long timeout, java.util.concurrent.TimeUnit timeUnit) Load the underlying document, if not reduced with a custom timeout.
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

JsonDocument document()

Load the underlying document, if not reduced with the default view timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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:

the loaded document, null if not found.

document

JsonDocument document(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)

Load the underlying document, if not reduced with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the loaded document, null if not found.

document

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

Load the underlying document, if not reduced with the default view timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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 custom target document type.

Returns:

the loaded document, null if not found.

document

<D extends Document<?>> D document(java.lang.Class<D> target,
                                 long timeout,
                                 java.util.concurrent.TimeUnit timeUnit)

Load the underlying document, if not reduced with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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 custom target document type.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the loaded document, null if not found.