public class Passage extends Object
A passage contains getNumMatches()
highlights from the query,
and the offsets and query terms that correspond with each match.
Constructor and Description |
---|
Passage() |
Modifier and Type | Method and Description |
---|---|
void |
addMatch(int startOffset,
int endOffset,
BytesRef term,
int termFreqInDoc) |
int |
getEndOffset()
End offset of this passage.
|
int |
getLength() |
int[] |
getMatchEnds()
End offsets of the term matches, corresponding with
getMatchStarts() . |
int[] |
getMatchStarts()
Start offsets of the term matches, in increasing order.
|
int[] |
getMatchTermFreqsInDoc() |
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) |
String |
toString()
For debugging.
|
public void addMatch(int startOffset, int endOffset, BytesRef term, int termFreqInDoc)
public void reset()
public String toString()
public int getStartOffset()
public int getEndOffset()
getStartOffset()
public int getLength()
public float getScore()
public void setScore(float score)
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 int[] getMatchTermFreqsInDoc()
public void setStartOffset(int startOffset)
public void setEndOffset(int endOffset)
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.