org.elasticsearch.search.highlight
Class HighlightPhase

java.lang.Object
  org.elasticsearch.search.highlight.HighlightPhase

All Implemented Interfaces:

FetchSubPhase

public class HighlightPhase
extends java.lang.Object
implements FetchSubPhase

Nested Class Summary

static class

HighlightPhase.Encoders

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

FetchSubPhase.HitContext

Constructor Summary

HighlightPhase()

Method Summary

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)
java.util.Map<java.lang.String,? extends SearchParseElement>	parseElements()

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightPhase

public HighlightPhase()

Method Detail

parseElements

public java.util.Map<java.lang.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)
                 throws ElasticSearchException

Specified by:

hitsExecute in interface FetchSubPhase

Throws:

ElasticSearchException

hitExecutionNeeded

public boolean hitExecutionNeeded(SearchContext context)

Specified by:

hitExecutionNeeded in interface FetchSubPhase

hitExecute

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

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

Throws:

ElasticSearchException