com.couchbase.client.java.view

Interface ViewResult

All Known Implementing Classes:

DefaultViewResult

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface ViewResult

Represents the result from a ViewQuery.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ViewRow>	allRows() Collects all rows received from the view with the default view timeout.
java.util.List<ViewRow>	allRows(long timeout, java.util.concurrent.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.
java.util.Iterator<ViewRow>	rows() Emits one ViewRow for each row received from the view with the default view timeout.
java.util.Iterator<ViewRow>	rows(long timeout, java.util.concurrent.TimeUnit timeUnit) Emits one ViewRow for each row received from the view with a custom timeout.
boolean	success() If the query was successful.
int	totalRows() The total number of rows.

Method Detail

allRows

java.util.List<ViewRow> allRows()

Collects all rows received from the view with the default view timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Returns:

a (potentially empty) List containing view rows.

allRows

java.util.List<ViewRow> allRows(long timeout,
                              java.util.concurrent.TimeUnit timeUnit)

Collects all rows received from the view with the default view timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Returns:

a (potentially empty) List containing view rows.

rows

java.util.Iterator<ViewRow> rows()

Emits one ViewRow for each row received from the view with the default view timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Returns:

a (potentially empty) Iterator containing view rows.

rows

java.util.Iterator<ViewRow> rows(long timeout,
                               java.util.concurrent.TimeUnit timeUnit)

Emits one ViewRow for each row received from the view with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

a (potentially empty) Iterator containing view rows.

totalRows

int totalRows()

The total number of rows.

Returns:

number of rows.

success

boolean success()

If the query was successful.

Returns:

true if it was, false otherwise.

error

JsonObject error()

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

Returns:

the potential error.

debug

JsonObject debug()

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

Returns:

the debug info.