org.apache.lucene.search.highlight
public class Highlighter extends Object
Fragmenter
, Scorer
, Formatter
,
Encoder
and tokenizers.Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_MAX_DOC_BYTES_TO_ANALYZE |
Constructor and Description |
---|
Highlighter(Formatter formatter,
Encoder encoder,
Scorer fragmentScorer) |
Highlighter(Formatter formatter,
Scorer fragmentScorer) |
Highlighter(Scorer fragmentScorer) |
Modifier and Type | Method and Description |
---|---|
String |
getBestFragment(Analyzer analyzer,
String fieldName,
String text)
Highlights chosen terms in a text, extracting the most relevant section.
|
String |
getBestFragment(TokenStream tokenStream,
String text)
Highlights chosen terms in a text, extracting the most relevant section.
|
String[] |
getBestFragments(Analyzer analyzer,
String text,
int maxNumFragments)
Deprecated.
This method incorrectly hardcodes the choice of fieldname. Use the
method of the same name that takes a fieldname.
|
String[] |
getBestFragments(Analyzer analyzer,
String fieldName,
String text,
int maxNumFragments)
Highlights chosen terms in a text, extracting the most relevant sections.
|
String[] |
getBestFragments(TokenStream tokenStream,
String text,
int maxNumFragments)
Highlights chosen terms in a text, extracting the most relevant sections.
|
String |
getBestFragments(TokenStream tokenStream,
String text,
int maxNumFragments,
String separator)
Highlights terms in the text , extracting the most relevant sections
and concatenating the chosen fragments with a separator (typically "...").
|
TextFragment[] |
getBestTextFragments(TokenStream tokenStream,
String text,
boolean mergeContiguousFragments,
int maxNumFragments)
Low level api to get the most relevant (formatted) sections of the document.
|
Encoder |
getEncoder() |
Scorer |
getFragmentScorer() |
int |
getMaxDocBytesToAnalyze() |
Fragmenter |
getTextFragmenter() |
void |
setEncoder(Encoder encoder) |
void |
setFragmentScorer(Scorer scorer) |
void |
setMaxDocBytesToAnalyze(int byteCount) |
void |
setTextFragmenter(Fragmenter fragmenter) |
public static final int DEFAULT_MAX_DOC_BYTES_TO_ANALYZE
public Highlighter(Scorer fragmentScorer)
public final String getBestFragment(Analyzer analyzer, String fieldName, String text) throws IOException
getBestFragment(TokenStream, String)
analyzer
- the analyzer that will be used to split text
into chunkstext
- text to highlight terms infieldName
- Name of field used to influence analyzer's tokenization policyIOException
public final String getBestFragment(TokenStream tokenStream, String text) throws IOException
tokenStream
- a stream of tokens identified in the text parameter, including offset information.
This is typically produced by an analyzer re-parsing a document's
text. Some work may be done on retrieving TokenStreams more efficently
by adding support for storing original text position data in the Lucene
index but this support is not currently available (as of Lucene 1.4 rc2).text
- text to highlight terms inIOException
public final String[] getBestFragments(Analyzer analyzer, String text, int maxNumFragments) throws IOException
getBestFragments(TokenStream, String, int)
analyzer
- the analyzer that will be used to split text
into chunkstext
- text to highlight terms inmaxNumFragments
- the maximum number of fragments.IOException
public final String[] getBestFragments(Analyzer analyzer, String fieldName, String text, int maxNumFragments) throws IOException
getBestFragments(TokenStream, String, int)
analyzer
- the analyzer that will be used to split text
into chunksfieldName
- the name of the field being highlighted (used by analyzer)text
- text to highlight terms inmaxNumFragments
- the maximum number of fragments.IOException
public final String[] getBestFragments(TokenStream tokenStream, String text, int maxNumFragments) throws IOException
text
- text to highlight terms inmaxNumFragments
- the maximum number of fragments.IOException
public final TextFragment[] getBestTextFragments(TokenStream tokenStream, String text, boolean mergeContiguousFragments, int maxNumFragments) throws IOException
tokenStream
- text
- maxNumFragments
- mergeContiguousFragments
- IOException
public final String getBestFragments(TokenStream tokenStream, String text, int maxNumFragments, String separator) throws IOException
text
- text to highlight terms inmaxNumFragments
- the maximum number of fragments.separator
- the separator used to intersperse the document fragments (typically "...")IOException
public int getMaxDocBytesToAnalyze()
public void setMaxDocBytesToAnalyze(int byteCount)
byteCount
- the maximum number of bytes to be tokenized per doc
(This can improve performance with large documents)public Fragmenter getTextFragmenter()
public void setTextFragmenter(Fragmenter fragmenter)
fragmenter
- public Scorer getFragmentScorer()
public void setFragmentScorer(Scorer scorer)
scorer
- public Encoder getEncoder()
public void setEncoder(Encoder encoder)
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.