Package com.couchbase.client.java.view

Class DefaultSpatialViewResult

java.lang.Object

com.couchbase.client.java.view.DefaultSpatialViewResult

All Implemented Interfaces:

SpatialViewResult, Iterable<SpatialViewRow>

public class DefaultSpatialViewResult
extends Object
implements SpatialViewResult

Default implementation of the SpatialViewResult.

Since:

2.1.0

Author:

Michael Nitschinger

Constructor Summary

Constructors

Constructor	Description
DefaultSpatialViewResult(CouchbaseEnvironment env, Bucket bucket, rx.Observable<AsyncSpatialViewRow> rows, boolean success, rx.Observable<JsonObject> error, JsonObject debug)

Method Summary

Modifier and Type	Method	Description
List<SpatialViewRow>	allRows()	Collects all rows received from the view with the default view timeout.
List<SpatialViewRow>	allRows(long timeout, TimeUnit timeUnit)	Collects all rows received from the view with the default view timeout.
JsonObject	debug()	If debug was enabled on the query, it is contained here.
JsonObject	error()	If it was not successful, an error is contained here.
JsonObject	error(long timeout, TimeUnit timeUnit)	If it was not successful, an error is contained here.
Iterator<SpatialViewRow>	iterator()
Iterator<SpatialViewRow>	rows()	Emits one ViewRow for each row received from the view with the default view timeout.
Iterator<SpatialViewRow>	rows(long timeout, TimeUnit timeUnit)	Emits one ViewRow for each row received from the view with a custom timeout.
boolean	success()	If the query was successful.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultSpatialViewResult

public DefaultSpatialViewResult(CouchbaseEnvironment env,
                                Bucket bucket,
                                rx.Observable<AsyncSpatialViewRow> rows,
                                boolean success,
                                rx.Observable<JsonObject> error,
                                JsonObject debug)

Method Detail

allRows

public List<SpatialViewRow> allRows()

Description copied from interface: SpatialViewResult

Collects all rows received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.

Specified by:

allRows in interface SpatialViewResult

Returns:

a (potentially empty) List containing view rows.

allRows

public List<SpatialViewRow> allRows(long timeout,
                                    TimeUnit timeUnit)

Description copied from interface: SpatialViewResult

Collects all rows received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.

Specified by:

allRows in interface SpatialViewResult

Returns:

a (potentially empty) List containing view rows.

rows

public Iterator<SpatialViewRow> rows()

Description copied from interface: SpatialViewResult

Emits one ViewRow for each row received from the view with the default view timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.

Specified by:

rows in interface SpatialViewResult

Returns:

a (potentially empty) Iterator containing view rows.

rows

public Iterator<SpatialViewRow> rows(long timeout,
                                     TimeUnit timeUnit)

Description copied from interface: SpatialViewResult

Emits one ViewRow for each row received from the view with a custom timeout. This method throws: - TimeoutException wrapped in a RuntimeException: If the timeout is exceeded.

Specified by:

rows in interface SpatialViewResult

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

a (potentially empty) Iterator containing view rows.

success

public boolean success()

Description copied from interface: SpatialViewResult

If the query was successful.

Specified by:

success in interface SpatialViewResult

Returns:

true if it was, false otherwise.

error

public JsonObject error()

Description copied from interface: SpatialViewResult

If it was not successful, an error is contained here.

Specified by:

error in interface SpatialViewResult

Returns:

the potential error.

error

public JsonObject error(long timeout,
                        TimeUnit timeUnit)

Description copied from interface: SpatialViewResult

If it was not successful, an error is contained here.

Specified by:

error in interface SpatialViewResult

Returns:

the potential error.

debug

public JsonObject debug()

Description copied from interface: SpatialViewResult

If debug was enabled on the query, it is contained here.

Specified by:

debug in interface SpatialViewResult

Returns:

the debug info.

iterator

public Iterator<SpatialViewRow> iterator()

Specified by:

iterator in interface Iterable<SpatialViewRow>