|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PassageHighlighter
An interface for providing call back functions when doing passage highlighting. A passage consists of three parts:
Method Summary | |
---|---|
java.lang.String |
ellipsis()
Produces a string that will be used as an ellipsis when removing text from overly long passages. |
java.lang.String |
endContext()
Ends the context for the passage. |
java.lang.String |
endPassage()
Ends the highlighting for the entire passage. |
java.lang.StringBuffer |
highlightMatching(java.lang.String term,
int pos,
java.lang.StringBuffer b,
boolean htmlEncode)
Highlights one of the actual matching terms in the query. |
java.lang.String |
startContext()
Starts the context for the passage. |
java.lang.String |
startPassage()
Starts the highlighting for the passage. |
Method Detail |
---|
java.lang.String startContext()
java.lang.String endContext()
java.lang.String startPassage()
java.lang.String endPassage()
java.lang.String ellipsis()
java.lang.StringBuffer highlightMatching(java.lang.String term, int pos, java.lang.StringBuffer b, boolean htmlEncode)
term
- The matching term.pos
- The position of the matching term.b
- A buffer to encode the term onto.htmlEncode
- If true
the term must be html encoded
before being added.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |