Enum UnifiedHighlighter.HighlightFlag
- java.lang.Object
-
- java.lang.Enum<UnifiedHighlighter.HighlightFlag>
-
- org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
-
- All Implemented Interfaces:
Serializable
,Comparable<UnifiedHighlighter.HighlightFlag>
- Enclosing class:
- UnifiedHighlighter
public static enum UnifiedHighlighter.HighlightFlag extends Enum<UnifiedHighlighter.HighlightFlag>
Flags for controlling highlighting behavior.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description MULTI_TERM_QUERY
PASSAGE_RELEVANCY_OVER_SPEED
Passage relevancy is more important than speed.PHRASES
WEIGHT_MATCHES
Internally use theWeight.matches(LeafReaderContext, int)
API for highlighting.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static UnifiedHighlighter.HighlightFlag
valueOf(String name)
Returns the enum constant of this type with the specified name.static UnifiedHighlighter.HighlightFlag[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PHRASES
public static final UnifiedHighlighter.HighlightFlag PHRASES
-
MULTI_TERM_QUERY
public static final UnifiedHighlighter.HighlightFlag MULTI_TERM_QUERY
-
PASSAGE_RELEVANCY_OVER_SPEED
public static final UnifiedHighlighter.HighlightFlag PASSAGE_RELEVANCY_OVER_SPEED
Passage relevancy is more important than speed. True by default.
-
WEIGHT_MATCHES
public static final UnifiedHighlighter.HighlightFlag WEIGHT_MATCHES
Internally use theWeight.matches(LeafReaderContext, int)
API for highlighting. It's more accurate to the query, and the snippets can be a little different for phrases because the whole phrase is marked up instead of each word. The passage relevancy calculation can be different (maybe worse?) and it's slower when highlighting many fields. Use of this flag requiresMULTI_TERM_QUERY
andPHRASES
andPASSAGE_RELEVANCY_OVER_SPEED
. True by default because those booleans are true by default.
-
-
Method Detail
-
values
public static UnifiedHighlighter.HighlightFlag[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (UnifiedHighlighter.HighlightFlag c : UnifiedHighlighter.HighlightFlag.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static UnifiedHighlighter.HighlightFlag valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-