Package com.couchbase.client.java.view

Class DefaultSpatialViewRow

java.lang.Object

com.couchbase.client.java.view.DefaultSpatialViewRow

All Implemented Interfaces:

SpatialViewRow

public class DefaultSpatialViewRow
extends Object
implements SpatialViewRow

Default implementation of the SpatialViewRow.

Since:

2.1.0

Author:

Michael Nitschinger

Constructor Summary

Constructors

Constructor	Description
DefaultSpatialViewRow(CouchbaseEnvironment env, AsyncSpatialViewRow asyncViewRow)

Method Summary

Modifier and Type	Method	Description
JsonDocument	document()	Load the underlying document, if not reduced with the default view timeout.
JsonDocument	document(long timeout, TimeUnit timeUnit)	Load the underlying document, if not reduced with a custom 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.
JsonObject	geometry()
String	id()	The id of the document, if not reduced.
JsonArray	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

DefaultSpatialViewRow

public DefaultSpatialViewRow(CouchbaseEnvironment env,
                             AsyncSpatialViewRow asyncViewRow)

Method Detail

id

public String id()

Description copied from interface: SpatialViewRow

The id of the document, if not reduced.

Specified by:

id in interface SpatialViewRow

Returns:

the id of the document.

key

public JsonArray key()

Description copied from interface: SpatialViewRow

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

Specified by:

key in interface SpatialViewRow

Returns:

the key.

value

public Object value()

Description copied from interface: SpatialViewRow

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

Specified by:

value in interface SpatialViewRow

Returns:

the value.

geometry

public JsonObject geometry()

Specified by:

geometry in interface SpatialViewRow

document

public JsonDocument document()

Description copied from interface: SpatialViewRow

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 SpatialViewRow

Returns:

the loaded document, null if not found.

document

public JsonDocument document(long timeout,
                             TimeUnit timeUnit)

Description copied from interface: SpatialViewRow

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 SpatialViewRow

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: SpatialViewRow

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 SpatialViewRow

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: SpatialViewRow

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 SpatialViewRow

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