Module org.apache.lucene.highlighter

Package org.apache.lucene.search.uhighlight

Class UHComponents

java.lang.Object

org.apache.lucene.search.uhighlight.UHComponents

public class UHComponents
extends Object

A parameter object to hold the components a FieldOffsetStrategy needs.

Field Summary

Fields

Modifier and Type	Field	Description
private final LabelledCharArrayMatcher[]	automata
private final String	field
private final Predicate<String>	fieldMatcher
private final boolean	hasUnrecognizedQueryPart
private final Set<UnifiedHighlighter.HighlightFlag>	highlightFlags
private final PhraseHelper	phraseHelper
private final Query	query
private final BytesRef[]	terms

Constructor Summary

Constructors

Constructor	Description
UHComponents(String field, Predicate<String> fieldMatcher, Query query, BytesRef[] terms, PhraseHelper phraseHelper, LabelledCharArrayMatcher[] automata, boolean hasUnrecognizedQueryPart, Set<UnifiedHighlighter.HighlightFlag> highlightFlags)

Method Summary

Modifier and Type	Method	Description
LabelledCharArrayMatcher[]	getAutomata()
String	getField()
Predicate<String>	getFieldMatcher()
Set<UnifiedHighlighter.HighlightFlag>	getHighlightFlags()
PhraseHelper	getPhraseHelper()
Query	getQuery()
BytesRef[]	getTerms()
boolean	hasUnrecognizedQueryPart()

Methods inherited from class java.lang.Object

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

Field Details

field

private final String field

fieldMatcher

private final Predicate<String> fieldMatcher

query

private final Query query

terms

private final BytesRef[] terms

phraseHelper

private final PhraseHelper phraseHelper

automata

private final LabelledCharArrayMatcher[] automata

hasUnrecognizedQueryPart

private final boolean hasUnrecognizedQueryPart

highlightFlags

private final Set<UnifiedHighlighter.HighlightFlag> highlightFlags

Constructor Details

UHComponents

public UHComponents(String field,
 Predicate<String> fieldMatcher,
 Query query,
 BytesRef[] terms,
 PhraseHelper phraseHelper,
 LabelledCharArrayMatcher[] automata,
 boolean hasUnrecognizedQueryPart,
 Set<UnifiedHighlighter.HighlightFlag> highlightFlags)

Method Details

getField

public String getField()

getFieldMatcher

public Predicate<String> getFieldMatcher()

getQuery

public Query getQuery()

getTerms

public BytesRef[] getTerms()

getPhraseHelper

public PhraseHelper getPhraseHelper()

getAutomata

public LabelledCharArrayMatcher[] getAutomata()

hasUnrecognizedQueryPart

public boolean hasUnrecognizedQueryPart()

getHighlightFlags

public Set<UnifiedHighlighter.HighlightFlag> getHighlightFlags()