org.elasticsearch.search.highlight

Class HighlightPhase

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.search.highlight.HighlightPhase

All Implemented Interfaces:

FetchSubPhase

public class HighlightPhase
extends AbstractComponent
implements FetchSubPhase

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.fetch.FetchSubPhase

FetchSubPhase.ContextFactory<SubPhaseContext extends FetchSubPhaseContext>, FetchSubPhase.HitContext

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
HighlightPhase(Settings settings, Highlighters highlighters)

Method Summary

Modifier and Type	Method and Description
void	hitExecute(SearchContext context, FetchSubPhase.HitContext hitContext) Executes the hit level phase, with a reader and doc id (note, its a low level reader, and the matching doc).
boolean	hitExecutionNeeded(SearchContext context)
void	hitsExecute(SearchContext context, InternalSearchHit[] hits)
boolean	hitsExecutionNeeded(SearchContext context)
Map<String,? extends SearchParseElement>	parseElements()

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightPhase

@Inject
public HighlightPhase(Settings settings,
                              Highlighters highlighters)

Method Detail

parseElements

public Map<String,? extends SearchParseElement> parseElements()

Specified by:

parseElements in interface FetchSubPhase

hitsExecutionNeeded

public boolean hitsExecutionNeeded(SearchContext context)

Specified by:

hitsExecutionNeeded in interface FetchSubPhase

hitsExecute

public void hitsExecute(SearchContext context,
                        InternalSearchHit[] hits)

Specified by:

hitsExecute in interface FetchSubPhase

hitExecutionNeeded

public boolean hitExecutionNeeded(SearchContext context)

Specified by:

hitExecutionNeeded in interface FetchSubPhase

hitExecute

public void hitExecute(SearchContext context,
                       FetchSubPhase.HitContext hitContext)

Description copied from interface: FetchSubPhase

Executes the hit level phase, with a reader and doc id (note, its a low level reader, and the matching doc).

Specified by:

hitExecute in interface FetchSubPhase