Module org.apache.lucene.highlighter

Package org.apache.lucene.search.matchhighlight

Class MatchHighlighter

java.lang.Object

org.apache.lucene.search.matchhighlight.MatchHighlighter

public class MatchHighlighter
extends Object

An example highlighter that combines several lower-level highlighting utilities in this package into a fully featured, ready-to-use component.

Note that if you need to customize or tweak the details of highlighting, it is better to assemble your own highlighter using those low-level building blocks, rather than extend or modify this one.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatchHighlighter.DocHighlights	Single document's highlights.
private static class	MatchHighlighter.DocHit
static interface	MatchHighlighter.FieldValueHighlighter	Actual per-field highlighter.
static class	MatchHighlighter.QueryOffsetRange	An OffsetRange of a match, together with the source query that caused it.

Field Summary

Fields

Modifier and Type	Field	Description
private final Analyzer	analyzer
private final List<MatchHighlighter.FieldValueHighlighter>	fieldHighlighters
private final HashSet<String>	fieldsAlwaysReturned
private final OffsetsRetrievalStrategySupplier	offsetsRetrievalStrategies
private final IndexSearcher	searcher

Constructor Summary

Constructors

Constructor	Description
MatchHighlighter(IndexSearcher searcher, Analyzer analyzer)
MatchHighlighter(IndexSearcher searcher, Analyzer analyzer, OffsetsRetrievalStrategySupplier offsetsRetrievalStrategies)

Method Summary

Modifier and Type	Method	Description
void	alwaysFetchFields(String... fields)	Always fetch the given set of fields for all input documents.
MatchHighlighter	appendFieldHighlighter(MatchHighlighter.FieldValueHighlighter highlighter)	Append a new highlighter to field highlighters chain.
private MatchHighlighter.DocHighlights	computeDocFieldValues(MatchHighlighter.DocHit docHit)
private List<OffsetRange>	computeValueRanges(String field, String[] values)
private String	contiguousFieldValue(String field, String[] values)
private MatchHighlighter.FieldValueHighlighter	fieldValueHighlighter(String field, boolean hasMatches)
Stream<MatchHighlighter.DocHighlights>	highlight(TopDocs topDocs, Query... queries)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

searcher

private final IndexSearcher searcher

offsetsRetrievalStrategies

private final OffsetsRetrievalStrategySupplier offsetsRetrievalStrategies

analyzer

private final Analyzer analyzer

fieldsAlwaysReturned

private final HashSet<String> fieldsAlwaysReturned

fieldHighlighters

private final List<MatchHighlighter.FieldValueHighlighter> fieldHighlighters

Constructor Details

MatchHighlighter

public MatchHighlighter(IndexSearcher searcher,
 Analyzer analyzer)

MatchHighlighter

public MatchHighlighter(IndexSearcher searcher,
 Analyzer analyzer,
 OffsetsRetrievalStrategySupplier offsetsRetrievalStrategies)

Method Details

appendFieldHighlighter

public MatchHighlighter appendFieldHighlighter(MatchHighlighter.FieldValueHighlighter highlighter)

Append a new highlighter to field highlighters chain. The order of field highlighters is important (first-matching wins).

alwaysFetchFields

public void alwaysFetchFields(String... fields)

Always fetch the given set of fields for all input documents.

highlight

public Stream<MatchHighlighter.DocHighlights> highlight(TopDocs topDocs,
 Query... queries)
                                                 throws IOException

Throws:

IOException

computeDocFieldValues

private MatchHighlighter.DocHighlights computeDocFieldValues(MatchHighlighter.DocHit docHit)

computeValueRanges

private List<OffsetRange> computeValueRanges(String field,
 String[] values)

contiguousFieldValue

private String contiguousFieldValue(String field,
 String[] values)

fieldValueHighlighter

private MatchHighlighter.FieldValueHighlighter fieldValueHighlighter(String field,
 boolean hasMatches)