com.couchbase.client.java.search.result.impl

Class DefaultSearchQueryRow

java.lang.Object

com.couchbase.client.java.search.result.impl.DefaultSearchQueryRow

All Implemented Interfaces:

SearchQueryRow

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class DefaultSearchQueryRow
extends Object
implements SearchQueryRow

The default implementation for a SearchQueryRow

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor and Description
DefaultSearchQueryRow(String index, String id, double score, JsonObject explanation, HitLocations locations, Map<String,List<String>> fragments, Map<String,String> fields)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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).
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultSearchQueryRow

public DefaultSearchQueryRow(String index,
                             String id,
                             double score,
                             JsonObject explanation,
                             HitLocations locations,
                             Map<String,List<String>> fragments,
                             Map<String,String> fields)

Method Detail

index

public String index()

Description copied from interface: SearchQueryRow

The name of the FTS pindex that gave this result.

Specified by:

index in interface SearchQueryRow

id

public String id()

Description copied from interface: SearchQueryRow

The id of the matching document.

Specified by:

id in interface SearchQueryRow

score

public double score()

Description copied from interface: SearchQueryRow

The score of this hit.

Specified by:

score in interface SearchQueryRow

explanation

public JsonObject explanation()

Description copied from interface: SearchQueryRow

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

Specified by:

explanation in interface SearchQueryRow

Returns:

locations

public HitLocations locations()

Description copied from interface: SearchQueryRow

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

Specified by:

locations in interface SearchQueryRow

fragments

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

Description copied from interface: SearchQueryRow

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.

Specified by:

fragments in interface SearchQueryRow

Returns:

the fragments as a Map. Keys are the fields.

fields

public Map<String,String> fields()

Description copied from interface: SearchQueryRow

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

Specified by:

fields in interface SearchQueryRow

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object