nl.inl.blacklab.search.results

Interface Hit

All Superinterfaces:

Comparable<Hit>, Result<Hit>

All Known Implementing Classes:

HitImpl

public interface Hit
extends Result<Hit>

Interface for a hit. Normally, hits are iterated over in a Lucene Spans object, but in some places, it makes sense to place hits in separate objects: when caching or sorting hits, or just for convenience in client code.

Method Summary

Modifier and Type	Method and Description
default int	compareTo(Hit o)
static Hit	create(int doc, int start, int end) Create a hit.
int	doc() Get the document this hit occurs in.
int	end() Get the end of this hit.
int	start() Get the start of this hit.

Methods inherited from interface nl.inl.blacklab.search.results.Result

equals, hashCode, toString

Method Detail

create

static Hit create(int doc,
                  int start,
                  int end)

Create a hit.

Parameters:

doc - Lucene document id

start - position of first word of the hit

end - first word position after the hit

Returns:

the hit

compareTo

default int compareTo(Hit o)

Specified by:

compareTo in interface Comparable<Hit>

Specified by:

compareTo in interface Result<Hit>

doc

int doc()

Get the document this hit occurs in.

Returns:

Lucene document id

start

int start()

Get the start of this hit.

Returns:

position of first word of the hit

end

int end()

Get the end of this hit.

Returns:

position of first word after the hit