Class SearchRow
- java.lang.Object
-
- com.couchbase.client.java.search.result.SearchRow
-
public class SearchRow extends Object
An FTS result row (or hit).- Since:
- 2.3.0
-
-
Constructor Summary
Constructors Constructor Description SearchRow(String index, String id, double score, JsonObject explanation, Optional<SearchRowLocations> locations, Map<String,List<String>> fragments, byte[] fields, JsonSerializer serializer)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)JsonObjectexplanation()IfSearchOptions.explain(boolean)() requested in the query}, an explanation of the match, in JSON form.<T> TfieldsAs(TypeRef<T> target)The value of each requested field (as defined in theSearchQuery.<T> TfieldsAs(Class<T> target)The value of each requested field (as defined in theSearchQuery.Map<String,List<String>>fragments()The fragments for each field that was requested as highlighted (as defined in theSearchParams).static SearchRowfromResponse(SearchChunkRow row, JsonSerializer serializer)inthashCode()Stringid()The id of the matching document.Stringindex()The name of the FTS index that gave this result.Optional<SearchRowLocations>locations()This rows's location, as anSearchRowLocationsmap-like object.doublescore()The score of this hit.StringtoString()
-
-
-
Constructor Detail
-
SearchRow
public SearchRow(String index, String id, double score, JsonObject explanation, Optional<SearchRowLocations> locations, Map<String,List<String>> fragments, byte[] fields, JsonSerializer serializer)
-
-
Method Detail
-
index
public String index()
The name of the FTS index that gave this result.
-
id
public String id()
The id of the matching document.
-
score
public double score()
The score of this hit.
-
explanation
public JsonObject explanation()
IfSearchOptions.explain(boolean)() requested in the query}, an explanation of the match, in JSON form.
-
locations
public Optional<SearchRowLocations> locations()
This rows's location, as anSearchRowLocationsmap-like object.
-
fragments
public Map<String,List<String>> fragments()
The fragments for each field that was requested as highlighted (as defined in theSearchParams).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.
-
fieldsAs
public <T> T fieldsAs(Class<T> target)
The value of each requested field (as defined in theSearchQuery.- Returns:
- the fields mapped to the given target type
-
fieldsAs
public <T> T fieldsAs(TypeRef<T> target)
The value of each requested field (as defined in theSearchQuery.- Returns:
- the fields mapped to the given target type
-
fromResponse
public static SearchRow fromResponse(SearchChunkRow row, JsonSerializer serializer)
-
-