Interface SearchQueryRow
-
- All Known Implementing Classes:
DefaultSearchQueryRow
@Committed @Public public interface SearchQueryRow
An FTS result row (or hit).- Since:
- 2.3.0
- Author:
- Simon Baslé, Michael Nitschinger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JsonObject
explanation()
Ifrequested in the query
, an explanation of the match, in JSON form.Map<String,String>
fields()
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
).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 anHitLocations
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()
Ifrequested in the query
, an explanation of the match, in JSON form.
-
locations
HitLocations locations()
This hit's location, as anHitLocations
map-like object.
-
fragments
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.
-
fields
Map<String,String> fields()
The value of each requested field (as defined in theSearchQuery
.- Returns:
- the fields values as a
Map
. Keys are the fields.
-
-