com.couchbase.client.java.search.result

Interface SearchQueryRow

All Known Implementing Classes:

DefaultSearchQueryRow

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public interface SearchQueryRow

An FTS result row (or hit).

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Method Summary

Modifier and Type	Method and Description
JsonObject	explanation() If requested in the query, an explanation of the match, in JSON form.
Map<String,String>	fields() The value of each requested field (as defined in the SearchQuery.
Map<String,List<String>>	fragments() The fragments for each field that was requested as highlighted (as defined in the SearchParams).
String	id() The id of the matching document.
String	index() The name of the FTS pindex that gave this result.
HitLocations	locations() This hit’s location, as an HitLocations map-like object.
double	score() The score of this hit.

Method Detail

index

String index()

The name of the FTS pindex that gave this result.

id

String id()

The id of the matching document.

score

double score()

The score of this hit.

explanation

JsonObject explanation()

If requested in the query, an explanation of the match, in JSON form.

Returns:

locations

HitLocations locations()

This hit’s location, as an HitLocations map-like object.

fragments

Map<String,List<String>> fragments()

The fragments for each field that was requested as highlighted (as defined in the SearchParams).

A fragment is an extract of the field’s value where the matching terms occur. Matching terms are surrounded by a <match> tag.

Returns:

the fragments as a Map. Keys are the fields.

fields

Map<String,String> fields()

The value of each requested field (as defined in the SearchQuery.

Returns:

the fields values as a Map. Keys are the fields.