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

Interface ExtendedSearchProjectionFactory<SR,S extends ExtendedSearchProjectionFactory<SR,?,R,E>,R,E>

Type Parameters:

SR - Scope root type.

S - The self type, i.e. the exposed type of this factory.

All Superinterfaces:

SearchProjectionFactory<R,E>, TypedSearchProjectionFactory<SR,R,E>

All Known Subinterfaces:

ElasticsearchSearchProjectionFactory<SR,R,E>, LuceneSearchProjectionFactory<SR,R,E>

All Known Implementing Classes:

AbstractSearchProjectionFactory

public interface ExtendedSearchProjectionFactory<SR,S extends ExtendedSearchProjectionFactory<SR,?,R,E>,R,E>
extends TypedSearchProjectionFactory<SR,R,E>

A base interface for subtypes of TypedSearchProjectionFactory allowing to easily override the self type for all relevant methods.

Warning: Generic parameters of this type are subject to change, so this type should not be referenced directly in user code.

Method Summary

Modifier and Type	Method	Description
S	withRoot(String objectFieldPath)	Create a new projection factory whose root for all paths passed to the DSL will be the given object field.
<SR2> ExtendedSearchProjectionFactory<SR2,?,R,E>	withScopeRoot(Class<SR2> scopeRootType)

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory

composite, composite, composite, composite, composite, composite, composite, composite, composite, composite, composite, constant, distance, documentReference, entity, entity, entityReference, extension, field, field, field, field, field, field, highlight, id, id, object, score, toAbsolutePath, withParameters

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.TypedSearchProjectionFactory

distance, extension, field, highlight, object

Method Details

withRoot

S withRoot(String objectFieldPath)

Description copied from interface: TypedSearchProjectionFactory

Create a new projection factory whose root for all paths passed to the DSL will be the given object field.

This is used to call reusable methods that can apply the same projection on different object fields that have same structure (same sub-fields).

Specified by:

withRoot in interface SearchProjectionFactory<SR,S extends ExtendedSearchProjectionFactory<SR,?,R,E>>

Specified by:

withRoot in interface TypedSearchProjectionFactory<SR,S extends ExtendedSearchProjectionFactory<SR,?,R,E>,R>

Parameters:

objectFieldPath - The path from the current root to an object field that will become the new root.

Returns:

A new projection factory using the given object field as root.

withScopeRoot

@Incubating
<SR2> ExtendedSearchProjectionFactory<SR2,?,R,E> withScopeRoot(Class<SR2> scopeRootType)

Throws:

SearchException - In case the current factory cannot be rescoped for the scopeRootType.