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

Interface SearchPredicateBuilderFactory<C>

Type Parameters:

C - The type of query element collector

public interface SearchPredicateBuilderFactory<C>

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	Description
BooleanPredicateBuilder	bool()
void	contribute(C collector, SearchPredicate predicate)	Contribute a predicate builder to a collector.
ExistsPredicateBuilder	exists(String absoluteFieldPath)
MatchIdPredicateBuilder	id()
MatchPredicateBuilder	match(String absoluteFieldPath)
MatchAllPredicateBuilder	matchAll()
NestedPredicateBuilder	nested(String absoluteFieldPath)
PhrasePredicateBuilder	phrase(String absoluteFieldPath)
RangePredicateBuilder	range(String absoluteFieldPath)
SimpleQueryStringPredicateBuilder	simpleQueryString()
SpatialWithinBoundingBoxPredicateBuilder	spatialWithinBoundingBox(String absoluteFieldPath)
SpatialWithinCirclePredicateBuilder	spatialWithinCircle(String absoluteFieldPath)
SpatialWithinPolygonPredicateBuilder	spatialWithinPolygon(String absoluteFieldPath)
WildcardPredicateBuilder	wildcard(String absoluteFieldPath)

Method Detail

contribute

void contribute(C collector,
                SearchPredicate predicate)

Contribute a predicate builder to a collector.

Will only ever be called once per collector.

Parameters:

collector - The query element collector.

predicate - The predicate implementation.

matchAll

MatchAllPredicateBuilder matchAll()

id

MatchIdPredicateBuilder id()

bool

BooleanPredicateBuilder bool()

match

MatchPredicateBuilder match(String absoluteFieldPath)

range

RangePredicateBuilder range(String absoluteFieldPath)

phrase

PhrasePredicateBuilder phrase(String absoluteFieldPath)

wildcard

WildcardPredicateBuilder wildcard(String absoluteFieldPath)

nested

NestedPredicateBuilder nested(String absoluteFieldPath)

simpleQueryString

SimpleQueryStringPredicateBuilder simpleQueryString()

exists

ExistsPredicateBuilder exists(String absoluteFieldPath)

spatialWithinCircle

SpatialWithinCirclePredicateBuilder spatialWithinCircle(String absoluteFieldPath)

spatialWithinPolygon

SpatialWithinPolygonPredicateBuilder spatialWithinPolygon(String absoluteFieldPath)

spatialWithinBoundingBox

SpatialWithinBoundingBoxPredicateBuilder spatialWithinBoundingBox(String absoluteFieldPath)