public class Passage
extends java.lang.Object
A passage contains getNumMatches()
highlights from the query,
and the offsets and query terms that correspond with each match.
Modifier and Type | Field and Description |
---|---|
private int |
endOffset |
private int[] |
matchEnds |
private int[] |
matchStarts |
private BytesRef[] |
matchTerms |
private int |
numMatches |
private float |
score |
private int |
startOffset |
Constructor and Description |
---|
Passage() |
Modifier and Type | Method and Description |
---|---|
void |
addMatch(int startOffset,
int endOffset,
BytesRef term) |
int |
getEndOffset()
End offset of this passage.
|
int[] |
getMatchEnds()
End offsets of the term matches, corresponding with
getMatchStarts() . |
int[] |
getMatchStarts()
Start offsets of the term matches, in increasing order.
|
BytesRef[] |
getMatchTerms()
BytesRef (term text) of the matches, corresponding with
getMatchStarts() . |
int |
getNumMatches()
|
float |
getScore()
Passage's score.
|
int |
getStartOffset()
Start offset of this passage.
|
void |
reset() |
void |
setEndOffset(int endOffset) |
void |
setScore(float score) |
void |
setStartOffset(int startOffset) |
void |
sort() |
private int startOffset
private int endOffset
private float score
private int[] matchStarts
private int[] matchEnds
private BytesRef[] matchTerms
private int numMatches
public void addMatch(int startOffset, int endOffset, BytesRef term)
public void sort()
public void reset()
public int getStartOffset()
public int getEndOffset()
getStartOffset()
public float getScore()
public int getNumMatches()
public int[] getMatchStarts()
Only getNumMatches()
are valid. Note that these
offsets are absolute (not relative to getStartOffset()
).
public int[] getMatchEnds()
getMatchStarts()
.
Only getNumMatches()
are valid. Note that its possible that an end offset
could exceed beyond the bounds of the passage (getEndOffset()
), if the
Analyzer produced a term which spans a passage boundary.
public BytesRef[] getMatchTerms()
getMatchStarts()
.
Only getNumMatches()
are valid.
public void setStartOffset(int startOffset)
public void setEndOffset(int endOffset)
public void setScore(float score)