org.hibernate.search.engine.search.predicate.spi

Interface SearchPredicateBuilderFactory<C,B>

Type Parameters:

C - The type of query element collector

B - The implementation type of builders This type is backend-specific. See SearchPredicateBuilder.toImplementation()

public interface SearchPredicateBuilderFactory<C,B>

A factory for search predicate builders.

This is the main entry point for the engine to ask the backend to build search predicates.

Method Summary

Modifier and Type	Method and Description
BooleanJunctionPredicateBuilder<B>	bool()
void	contribute(C collector, B builder) Contribute a predicate builder to a collector.
MatchIdPredicateBuilder<B>	id()
MatchPredicateBuilder<B>	match(String absoluteFieldPath, DslConverter dslConverter)
MatchAllPredicateBuilder<B>	matchAll()
NestedPredicateBuilder<B>	nested(String absoluteFieldPath)
PhrasePredicateBuilder<B>	phrase(String absoluteFieldPath)
RangePredicateBuilder<B>	range(String absoluteFieldPath, DslConverter dslConverter)
SimpleQueryStringPredicateBuilder<B>	simpleQueryString()
SpatialWithinBoundingBoxPredicateBuilder<B>	spatialWithinBoundingBox(String absoluteFieldPath)
SpatialWithinCirclePredicateBuilder<B>	spatialWithinCircle(String absoluteFieldPath)
SpatialWithinPolygonPredicateBuilder<B>	spatialWithinPolygon(String absoluteFieldPath)
B	toImplementation(SearchPredicate predicate) Convert a SearchPredicate object back to a predicate builder.
SearchPredicate	toSearchPredicate(B builder) Convert a predicate builder to a reusable SearchPredicate object.
WildcardPredicateBuilder<B>	wildcard(String absoluteFieldPath)

Method Detail

toSearchPredicate

SearchPredicate toSearchPredicate(B builder)

Convert a predicate builder to a reusable SearchPredicate object.

Implementations may decide to just wrap the builder if it is reusable, or to convert it to another representation if it is not reusable.

Parameters:

builder - The predicate builder implementation.

Returns:

The corresponding reusable SearchPredicate object.

toImplementation

B toImplementation(SearchPredicate predicate)

Convert a SearchPredicate object back to a predicate builder.

May be called multiple times for a given SearchPredicate object.

Parameters:

predicate - The SearchPredicate object to convert.

Returns:

The corresponding predicate builder implementation.

Throws:

SearchException - If the SearchPredicate object was created by a different, incompatible factory.

contribute

void contribute(C collector,
                B builder)

Contribute a predicate builder to a collector.

Will only ever be called once per collector.

Parameters:

collector - The query element collector.

builder - The predicate builder implementation.

matchAll

MatchAllPredicateBuilder<B> matchAll()

id

MatchIdPredicateBuilder<B> id()

bool

BooleanJunctionPredicateBuilder<B> bool()

match

MatchPredicateBuilder<B> match(String absoluteFieldPath,
                               DslConverter dslConverter)

range

RangePredicateBuilder<B> range(String absoluteFieldPath,
                               DslConverter dslConverter)

phrase

PhrasePredicateBuilder<B> phrase(String absoluteFieldPath)

wildcard

WildcardPredicateBuilder<B> wildcard(String absoluteFieldPath)

nested

NestedPredicateBuilder<B> nested(String absoluteFieldPath)

simpleQueryString

SimpleQueryStringPredicateBuilder<B> simpleQueryString()

spatialWithinCircle

SpatialWithinCirclePredicateBuilder<B> spatialWithinCircle(String absoluteFieldPath)

spatialWithinPolygon

SpatialWithinPolygonPredicateBuilder<B> spatialWithinPolygon(String absoluteFieldPath)

spatialWithinBoundingBox

SpatialWithinBoundingBoxPredicateBuilder<B> spatialWithinBoundingBox(String absoluteFieldPath)