com.couchbase.client.java.view

Class DefaultViewRow

java.lang.Object

com.couchbase.client.java.view.DefaultViewRow

All Implemented Interfaces:

ViewRow

public class DefaultViewRow
extends Object
implements ViewRow

Constructor Summary

Constructors

Constructor and Description
DefaultViewRow(CouchbaseEnvironment env, AsyncViewRow asyncViewRow)

Method Summary

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(Class<D> target) Load the underlying document, if not reduced with the default view timeout.
<D extends Document<?>> D	document(Class<D> target, long timeout, TimeUnit timeUnit) Load the underlying document, if not reduced with a custom timeout.
JsonDocument	document(long timeout, TimeUnit timeUnit) Load the underlying document, if not reduced with a custom timeout.
String	id() The id of the document, if not reduced.
Object	key() The key of the row index.
String	toString()
Object	value() The value of the row index.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultViewRow

public DefaultViewRow(CouchbaseEnvironment env,
                      AsyncViewRow asyncViewRow)

Method Detail

id

public String id()

Description copied from interface: ViewRow

The id of the document, if not reduced.

Specified by:

id in interface ViewRow

Returns:

the id of the document.

key

public Object key()

Description copied from interface: ViewRow

The key of the row index. The object can be any valid JSON object, including JsonArray or JsonObject.

Specified by:

key in interface ViewRow

Returns:

the key.

value

public Object value()

Description copied from interface: ViewRow

The value of the row index. The object can be any valid JSON object, including JsonArray or JsonObject.

Specified by:

value in interface ViewRow

Returns:

the value.

document

public JsonDocument document()

Description copied from interface: ViewRow

Load the underlying document, if not reduced with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded. - BackpressureException: If the incoming request rate is too high to be processed. - IllegalStateException: If the view is reduced and the ID is null. - TranscodingException: If the response document could not be decoded.

Specified by:

document in interface ViewRow

Returns:

the loaded document, null if not found.

document

public JsonDocument document(long timeout,
                             TimeUnit timeUnit)

Description copied from interface: ViewRow

Load the underlying document, if not reduced with a custom timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded. - BackpressureException: If the incoming request rate is too high to be processed. - IllegalStateException: If the view is reduced and the ID is null. - TranscodingException: If the response document could not be decoded.

Specified by:

document in interface ViewRow

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the loaded document, null if not found.

document

public <D extends Document<?>> D document(Class<D> target)

Description copied from interface: ViewRow

Load the underlying document, if not reduced with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded. - BackpressureException: If the incoming request rate is too high to be processed. - IllegalStateException: If the view is reduced and the ID is null. - TranscodingException: If the response document could not be decoded.

Specified by:

document in interface ViewRow

Parameters:

target - the custom target document type.

Returns:

the loaded document, null if not found.

document

public <D extends Document<?>> D document(Class<D> target,
                                          long timeout,
                                          TimeUnit timeUnit)

Description copied from interface: ViewRow

Load the underlying document, if not reduced with a custom timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded. - BackpressureException: If the incoming request rate is too high to be processed. - IllegalStateException: If the view is reduced and the ID is null. - TranscodingException: If the response document could not be decoded.

Specified by:

document in interface ViewRow

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.

toString

public String toString()

Overrides:

toString in class Object