Package org.hibernate.search.engine.search.predicate.dsl

Interface ExtendedSearchPredicateFactory<SR,S extends ExtendedSearchPredicateFactory<SR,?>>

Type Parameters:

SR - Scope root type.

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

All Superinterfaces:

SearchPredicateFactory, TypedSearchPredicateFactory<SR>

All Known Subinterfaces:

ElasticsearchSearchPredicateFactory<SR>, LuceneSearchPredicateFactory<SR>

All Known Implementing Classes:

AbstractSearchPredicateFactory

public interface ExtendedSearchPredicateFactory<SR,S extends ExtendedSearchPredicateFactory<SR,?>>
extends TypedSearchPredicateFactory<SR>

A base interface for subtypes of TypedSearchPredicateFactory 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 predicate factory whose root for all paths passed to the DSL will be the given object field.
<SR2> ExtendedSearchPredicateFactory<SR2,?>	withScopeRoot(Class<SR2> scopeRootType)

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory

and, and, bool, extension, id, matchNone, named, not, not, or, or, withParameters

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.TypedSearchPredicateFactory

and, bool, exists, extension, knn, match, matchAll, nested, nested, nested, or, phrase, prefix, queryString, range, regexp, simpleQueryString, spatial, terms, toAbsolutePath, wildcard

Method Details

withRoot

S withRoot(String objectFieldPath)

Description copied from interface: TypedSearchPredicateFactory

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

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

Specified by:

withRoot in interface SearchPredicateFactory

Specified by:

withRoot in interface TypedSearchPredicateFactory<SR>

Parameters:

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

Returns:

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

withScopeRoot

@Incubating
<SR2> ExtendedSearchPredicateFactory<SR2,?> withScopeRoot(Class<SR2> scopeRootType)

Throws:

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