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

Class HitLocation

java.lang.Object

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

@Uncommitted
@Public
public class HitLocation
extends Object

A FTS result hit location indicates at which position a given term occurs inside a given field. In case the field is an array, arrayPositions will indicate which index/indices in the array contain the term.

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Constructor Summary

Constructors

Constructor	Description
HitLocation(String field, String term, long pos, long start, long end)
HitLocation(String field, String term, long pos, long start, long end, long[] arrayPositions)

Method Summary

Modifier and Type	Method	Description
long[]	arrayPositions()
long	end()
boolean	equals(Object o)
String	field()
int	hashCode()
long	pos()
long	start()
String	term()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HitLocation

public HitLocation(String field,
                   String term,
                   long pos,
                   long start,
                   long end,
                   long[] arrayPositions)

HitLocation

public HitLocation(String field,
                   String term,
                   long pos,
                   long start,
                   long end)

Method Detail

field

public String field()

term

public String term()

pos

public long pos()

start

public long start()

end

public long end()

arrayPositions

public long[] arrayPositions()

Returns:

the array positions, or null if not applicable.

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