io.orchestrate.client

Class Result<T>

java.lang.Object

io.orchestrate.client.Result<T>

Type Parameters:

T - The deserializable type for the value of the KV data belonging to this search result.

public class Result<T>
extends java.lang.Object

A container for the search result and its associated KV data.

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getDistance() The distance from the geo coordinate in the query of this search result.
KvObject<T>	getKvObject() Returns the KV object for this search result.
double	getScore() Returns the score of this search results.

Methods inherited from class java.lang.Object

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

Method Detail

getKvObject

public final KvObject<T> getKvObject()

Returns the KV object for this search result.

Returns:

The KV object for this result.

getScore

public final double getScore()

Returns the score of this search results.

Returns:

The score for this result.

getDistance

@Nullable
public final java.lang.Double getDistance()

The distance from the geo coordinate in the query of this search result. The units of value for this data are the same as the units used in the query. This value will only be present when a sort on distance is combined with the geospatial query.

Returns:

The distance for this result.