public final class Cursor
extends java.lang.Object
implements java.io.Serializable
Query
during a search on the Index
.
For example, the following code shows how to use a cursor to get the next page of results
Index index = ... Cursor cursor = Cursor.newBuilder().build(); Query query = Query.newBuilder().setOptions( QueryOptions.newBuilder().setCursor(cursor).build("some query")); // Get the first page of results Results<ScoredDocument> results = index.search(query); // process results ... // Get the next set of results from the returned cursor query = Query.newBuilder().setOptions( QueryOptions.newBuilder().setCursor( results.getCursor()).build("some query")); results = index.search(query);
Alternatively, you can get a cursor to continue from each of the returned results.
Cursor cursor = Cursor.newBuilder().setPerResult(true).build(); Query query = Query.newBuilder().setOptions( QueryOptions.newBuilder().setCursor(cursor).build("some query")); // Get the first page of results Results<ScoredDocument> results = index.search(query); // process results for (ScoredDocument result : results) { // choose a cursor from one of the results cursor = result.getCursor(); } // Get the next set of results from the result's cursor query = Query.newBuilder().setOptions( QueryOptions.newBuilder().setCursor(cursor).build("some query")); results = index.search(query);
Modifier and Type | Class and Description |
---|---|
static class |
Cursor.Builder
A builder which constructs Cursor objects.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isPerResult() |
static Cursor.Builder |
newBuilder()
Creates and returns a
Cursor builder. |
static Cursor.Builder |
newBuilder(Cursor request)
Creates a builder from the given request.
|
java.lang.String |
toString() |
java.lang.String |
toWebSafeString()
A web safe string representing a cursor returned from a previous set of
search results to use as a starting point to retrieve the next
set of results.
|
public java.lang.String toWebSafeString()
public boolean isPerResult()
public static Cursor.Builder newBuilder()
Cursor
builder. Set the search request
parameters and use the Cursor.Builder.build()
method to create a concrete
instance of Cursor.Cursor.Builder
which can construct a search requestpublic static Cursor.Builder newBuilder(Cursor request)
request
- the search request for the builder to use
to build another requestpublic java.lang.String toString()
toString
in class java.lang.Object