com.couchbase.client.java.search.result.hits

Class DefaultHitLocations

java.lang.Object

com.couchbase.client.java.search.result.hits.DefaultHitLocations

All Implemented Interfaces:

HitLocations

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class DefaultHitLocations
extends Object
implements HitLocations

A default implementation of a HitLocations.

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor and Description
DefaultHitLocations()

Method Summary

Modifier and Type	Method and Description
HitLocations	add(HitLocation l) add a location and allow method chaining
long	count() size of all()
List<String>	fields() list the fields in this location
static HitLocations	from(JsonObject locationsJson) Parses a FTS JSON representation of a HitLocations.
List<HitLocation>	get(String field) list all locations for a given field (any term)
List<HitLocation>	get(String field, String term) list all locations for a given field and term
List<HitLocation>	getAll() list all locations (any field, any term)
Set<String>	terms() list all terms in this locations, considering all fields (so a set)
List<String>	termsFor(String field) list the terms for a given field
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHitLocations

public DefaultHitLocations()

Method Detail

add

public HitLocations add(HitLocation l)

Description copied from interface: HitLocations

add a location and allow method chaining

Specified by:

add in interface HitLocations

get

public List<HitLocation> get(String field)

Description copied from interface: HitLocations

list all locations for a given field (any term)

Specified by:

get in interface HitLocations

get

public List<HitLocation> get(String field,
                             String term)

Description copied from interface: HitLocations

list all locations for a given field and term

Specified by:

get in interface HitLocations

getAll

public List<HitLocation> getAll()

Description copied from interface: HitLocations

list all locations (any field, any term)

Specified by:

getAll in interface HitLocations

count

public long count()

Description copied from interface: HitLocations

size of all()

Specified by:

count in interface HitLocations

fields

public List<String> fields()

Description copied from interface: HitLocations

list the fields in this location

Specified by:

fields in interface HitLocations

termsFor

public List<String> termsFor(String field)

Description copied from interface: HitLocations

list the terms for a given field

Specified by:

termsFor in interface HitLocations

terms

public Set<String> terms()

Description copied from interface: HitLocations

list all terms in this locations, considering all fields (so a set)

Specified by:

terms in interface HitLocations

from

public static HitLocations from(JsonObject locationsJson)

Parses a FTS JSON representation of a HitLocations.

toString

public String toString()

Overrides:

toString in class Object