Package org.hibernate.search.engine.search.projection.dsl.impl

Class HighlightProjectionOptionsStepImpl

java.lang.Object

org.hibernate.search.engine.search.projection.dsl.impl.HighlightProjectionOptionsStepImpl

All Implemented Interfaces:

HighlightProjectionFinalStep, HighlightProjectionOptionsStep, ProjectionFinalStep<List<String>>

public class HighlightProjectionOptionsStepImpl
extends Object
implements HighlightProjectionOptionsStep, HighlightProjectionFinalStep

Constructor Summary

Constructors

Constructor	Description
HighlightProjectionOptionsStepImpl(SearchProjectionDslContext<?> dslContext, String fieldPath)

Method Summary

Modifier and Type	Method	Description
HighlightProjectionOptionsStep	highlighter(String highlighterName)	Defines a name of a named highlighter to be used by this field projection.
SingleHighlightProjectionFinalStep	single()	Defines the projection as single-valued, i.e. returning String instead of List<String>.
SearchProjection<List<String>>	toProjection()	Create a SearchProjection instance matching the definition given in the previous DSL steps.

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightProjectionOptionsStepImpl

public HighlightProjectionOptionsStepImpl(SearchProjectionDslContext<?> dslContext,
 String fieldPath)

Method Details

highlighter

public HighlightProjectionOptionsStep highlighter(String highlighterName)

Description copied from interface: HighlightProjectionOptionsStep

Defines a name of a named highlighter to be used by this field projection.

Specified by:

highlighter in interface HighlightProjectionOptionsStep

Parameters:

highlighterName - The name of a highlighter defined on the query.

Returns:

A final step to finish the definition of a highlight projection.

See Also:

• SearchQueryOptionsStep.highlighter(String, Function)

single

public SingleHighlightProjectionFinalStep single()

Description copied from interface: HighlightProjectionOptionsStep

Defines the projection as single-valued, i.e. returning String instead of List<String>.

Can only be used when the highlighter that creates highlighted fragments for this projection is configured to return a single fragment at most, i.e. when .numberOfFragments(1) is applied to the highlighter. Otherwise, it will lead to an exception being thrown when the query is created.

Specified by:

single in interface HighlightProjectionOptionsStep

Returns:

A final step in the highlight projection definition.

See Also:

• HighlighterOptionsStep.numberOfFragments(int)

toProjection

public SearchProjection<List<String>> toProjection()

Description copied from interface: ProjectionFinalStep

Create a SearchProjection instance matching the definition given in the previous DSL steps.

Specified by:

toProjection in interface ProjectionFinalStep<List<String>>

Returns:

The SearchProjection instance.