Package org.hibernate.search.backend.lucene.search.highlighter.impl

Class LuceneAbstractSearchHighlighter

java.lang.Object

org.hibernate.search.backend.lucene.search.highlighter.impl.LuceneAbstractSearchHighlighter

All Implemented Interfaces:

SearchHighlighter

public abstract class LuceneAbstractSearchHighlighter
extends Object
implements SearchHighlighter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuceneAbstractSearchHighlighter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected Character[]	boundaryChars
protected Integer	boundaryMaxScan
protected Locale	boundaryScannerLocale
protected BoundaryScannerType	boundaryScannerType
protected org.apache.lucene.search.highlight.Encoder	encoder
protected HighlighterFragmenter	fragmenterType
protected Integer	fragmentSize
protected Set<String>	indexNames
protected static Log	log
protected Integer	noMatchSize
protected Integer	numberOfFragments
protected Boolean	orderByScore
protected Integer	phraseLimit
protected List<String>	postTags
protected List<String>	preTags

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LuceneAbstractSearchHighlighter(Set<String> indexNames, Character[] boundaryChars, Integer boundaryMaxScan, Integer fragmentSize, Integer noMatchSize, Integer numberOfFragments, Boolean orderByScore, List<String> preTags, List<String> postTags, BoundaryScannerType boundaryScannerType, Locale boundaryScannerLocale, HighlighterFragmenter fragmenterType, Integer phraseLimit, org.apache.lucene.search.highlight.Encoder encoder)
protected	LuceneAbstractSearchHighlighter(LuceneAbstractSearchHighlighter.Builder builder)
protected	LuceneAbstractSearchHighlighter(BoundaryScannerType scannerType)

Method Summary

Modifier and Type	Method	Description
protected abstract LuceneAbstractSearchHighlighter	createHighlighterSameType(Set<String> indexNames, Character[] boundaryChars, Integer boundaryMaxScan, Integer fragmentSize, Integer noMatchSize, Integer numberOfFragments, Boolean orderByScore, List<String> preTags, List<String> postTags, BoundaryScannerType boundaryScannerType, Locale boundaryScannerLocale, HighlighterFragmenter fragmenterType, Integer phraseLimit, org.apache.lucene.search.highlight.Encoder encoder)
abstract <A> Values<A>	createValues(String parentDocumentPath, String nestedDocumentPath, String absoluteFieldPath, org.apache.lucene.analysis.Analyzer analyzer, ProjectionExtractContext context, ProjectionAccumulator<String,?,A,List<String>> accumulator)
static LuceneAbstractSearchHighlighter	defaultHighlighter()
static LuceneAbstractSearchHighlighter	from(LuceneSearchIndexScope<?> scope, SearchHighlighter highlighter)
Set<String>	indexNames()
void	request(ProjectionRequestContext context, String absoluteFieldPath)
abstract SearchHighlighterType	type()
LuceneAbstractSearchHighlighter	withFallback(LuceneAbstractSearchHighlighter fallback)
abstract LuceneAbstractSearchHighlighter	withFallbackDefaults()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Log log

indexNames

protected final Set<String> indexNames

boundaryChars

protected final Character[] boundaryChars

boundaryMaxScan

protected final Integer boundaryMaxScan

fragmentSize

protected final Integer fragmentSize

noMatchSize

protected final Integer noMatchSize

numberOfFragments

protected final Integer numberOfFragments

orderByScore

protected final Boolean orderByScore

preTags

protected final List<String> preTags

postTags

protected final List<String> postTags

boundaryScannerType

protected final BoundaryScannerType boundaryScannerType

boundaryScannerLocale

protected final Locale boundaryScannerLocale

fragmenterType

protected final HighlighterFragmenter fragmenterType

phraseLimit

protected final Integer phraseLimit

encoder

protected final org.apache.lucene.search.highlight.Encoder encoder

Constructor Detail

LuceneAbstractSearchHighlighter

protected LuceneAbstractSearchHighlighter(LuceneAbstractSearchHighlighter.Builder builder)

LuceneAbstractSearchHighlighter

protected LuceneAbstractSearchHighlighter(BoundaryScannerType scannerType)

LuceneAbstractSearchHighlighter

protected LuceneAbstractSearchHighlighter(Set<String> indexNames,
                                          Character[] boundaryChars,
                                          Integer boundaryMaxScan,
                                          Integer fragmentSize,
                                          Integer noMatchSize,
                                          Integer numberOfFragments,
                                          Boolean orderByScore,
                                          List<String> preTags,
                                          List<String> postTags,
                                          BoundaryScannerType boundaryScannerType,
                                          Locale boundaryScannerLocale,
                                          HighlighterFragmenter fragmenterType,
                                          Integer phraseLimit,
                                          org.apache.lucene.search.highlight.Encoder encoder)

Method Detail

from

public static LuceneAbstractSearchHighlighter from(LuceneSearchIndexScope<?> scope,
                                                   SearchHighlighter highlighter)

defaultHighlighter

public static LuceneAbstractSearchHighlighter defaultHighlighter()

withFallback

public LuceneAbstractSearchHighlighter withFallback(LuceneAbstractSearchHighlighter fallback)

createHighlighterSameType

protected abstract LuceneAbstractSearchHighlighter createHighlighterSameType(Set<String> indexNames,
                                                                             Character[] boundaryChars,
                                                                             Integer boundaryMaxScan,
                                                                             Integer fragmentSize,
                                                                             Integer noMatchSize,
                                                                             Integer numberOfFragments,
                                                                             Boolean orderByScore,
                                                                             List<String> preTags,
                                                                             List<String> postTags,
                                                                             BoundaryScannerType boundaryScannerType,
                                                                             Locale boundaryScannerLocale,
                                                                             HighlighterFragmenter fragmenterType,
                                                                             Integer phraseLimit,
                                                                             org.apache.lucene.search.highlight.Encoder encoder)

withFallbackDefaults

public abstract LuceneAbstractSearchHighlighter withFallbackDefaults()

indexNames

public Set<String> indexNames()

createValues

public abstract <A> Values<A> createValues(String parentDocumentPath,
                                           String nestedDocumentPath,
                                           String absoluteFieldPath,
                                           org.apache.lucene.analysis.Analyzer analyzer,
                                           ProjectionExtractContext context,
                                           ProjectionAccumulator<String,?,A,List<String>> accumulator)

type

public abstract SearchHighlighterType type()

request

public void request(ProjectionRequestContext context,
                    String absoluteFieldPath)