All Superinterfaces:

jakarta.persistence.criteria.CriteriaBuilder, HibernateCriteriaBuilder

All Known Subinterfaces:

GeolatteSpatialCriteriaBuilder, JTSSpatialCriteriaBuilder

All Known Implementing Classes:

GeolatteSpatialCriteriaBuilderImpl, JTSSpatialCriteriaBuilderImpl, SpatialCriteriaBuilderImpl
```
public interface SpatialCriteriaBuilder<T>
extends HibernateCriteriaBuilder
```
An extended HibernateCriteriaBuilder with spatial functionality

Nested Class Summary
- Nested classes/interfaces inherited from interface jakarta.persistence.criteria.CriteriaBuilder
  jakarta.persistence.criteria.CriteriaBuilder.Case<R extends Object>, jakarta.persistence.criteria.CriteriaBuilder.Coalesce<T extends Object>, jakarta.persistence.criteria.CriteriaBuilder.In<T extends Object>, jakarta.persistence.criteria.CriteriaBuilder.SimpleCase<C extends Object,R extends Object>, jakarta.persistence.criteria.CriteriaBuilder.Trimspec

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`jakarta.persistence.criteria.Predicate`	`contains(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially contains" constraint.
`jakarta.persistence.criteria.Predicate`	`contains(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially contains" constraint.
`jakarta.persistence.criteria.Predicate`	`crosses(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially crosses" constraint.
`jakarta.persistence.criteria.Predicate`	`crosses(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially crosses" constraint.
`jakarta.persistence.criteria.Predicate`	`disjoint(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially disjoint" constraint.
`jakarta.persistence.criteria.Predicate`	`disjoint(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially disjoint" constraint.
`jakarta.persistence.criteria.Predicate`	`distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2, double distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`jakarta.persistence.criteria.Predicate`	`distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2, jakarta.persistence.criteria.Expression<Double> distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`jakarta.persistence.criteria.Predicate`	`distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2, double distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`jakarta.persistence.criteria.Predicate`	`distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2, jakarta.persistence.criteria.Expression<Double> distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`jakarta.persistence.criteria.Predicate`	`eq(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially equal" constraint.
`jakarta.persistence.criteria.Predicate`	`eq(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially equal" constraint.
`jakarta.persistence.criteria.Predicate`	`havingSRID(jakarta.persistence.criteria.Expression<? extends T> geometry, int srid)`	Create a predicate for testing the arguments for "having srid" constraint.
`jakarta.persistence.criteria.Predicate`	`havingSRID(jakarta.persistence.criteria.Expression<? extends T> geometry, jakarta.persistence.criteria.Expression<Integer> srid)`	Create a predicate for testing the arguments for "having srid" constraint.
`jakarta.persistence.criteria.Predicate`	`intersects(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially intersects" constraint.
`jakarta.persistence.criteria.Predicate`	`intersects(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially intersects" constraint.
`jakarta.persistence.criteria.Predicate`	`isGeometryEmpty(jakarta.persistence.criteria.Expression<? extends T> geometry)`	Create a predicate for testing the arguments for "is empty" constraint.
`jakarta.persistence.criteria.Predicate`	`isGeometryNotEmpty(jakarta.persistence.criteria.Expression<? extends T> geometry)`	Create a predicate for testing the arguments for "is not empty" constraint.
`jakarta.persistence.criteria.Predicate`	`overlaps(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially overlaps" constraint.
`jakarta.persistence.criteria.Predicate`	`overlaps(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially overlaps" constraint.
`jakarta.persistence.criteria.Predicate`	`touches(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially touches" constraint.
`jakarta.persistence.criteria.Predicate`	`touches(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially touches" constraint.
`jakarta.persistence.criteria.Predicate`	`within(jakarta.persistence.criteria.Expression<? extends T> geometry1, jakarta.persistence.criteria.Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially within" constraint.
`jakarta.persistence.criteria.Predicate`	`within(jakarta.persistence.criteria.Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially within" constraint.

Methods inherited from interface org.hibernate.query.criteria.HibernateCriteriaBuilder
abs, acos, all, and, and, any, array, array, array, array, asc, asc, asc, asc, asin, atan, atan2, atan2, atan2, avg, avg, avg, avg, between, between, cast, ceiling, coalesce, coalesce, coalesce, collate, concat, concat, concat, concat, conjunction, construct, construct, cos, cosh, count, count, count, count, countDistinct, createCriteriaDelete, createCriteriaInsertSelect, createCriteriaUpdate, createQuery, createQuery, createTupleQuery, createWindow, cumeDist, currentDate, currentInstant, currentTime, currentTimestamp, day, degrees, denseRank, desc, desc, desc, desc, diff, diff, diff, disjunction, distinctFrom, distinctFrom, equal, equal, except, except, except, except, exceptAll, exceptAll, exists, exp, firstValue, fk, floor, format, frameBetweenFollowing, frameBetweenFollowing, frameBetweenPreceding, frameBetweenPreceding, frameCurrentRow, frameUnboundedFollowing, frameUnboundedPreceding, function, functionAggregate, functionAggregate, functionAggregate, functionWithinGroup, functionWithinGroup, functionWithinGroup, functionWithinGroup, ge, ge, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, greatest, gt, gt, hour, ilike, ilike, ilike, ilike, ilike, ilike, in, in, in, in, indexes, intersect, intersect, intersect, intersect, intersectAll, intersectAll, isEmpty, isFalse, isMapEmpty, isMapNotEmpty, isMember, isMember, isNotEmpty, isNotMember, isNotMember, isNotNull, isNull, isTrue, keys, lastValue, le, le, least, left, left, length, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, like, like, like, like, like, like, listagg, listagg, listagg, listagg, listagg, listagg, listagg, listagg, literal, literal, literals, literals, ln, localDate, localDateTime, localTime, locate, locate, locate, locate, log, log, log10, lower, lt, lt, mapSize, mapSize, max, min, minute, mod, mod, mod, mode, mode, mode, mode, month, neg, not, notDistinctFrom, notDistinctFrom, notEqual, notEqual, notIlike, notIlike, notIlike, notIlike, notIlike, notIlike, notLike, notLike, notLike, notLike, notLike, notLike, nthValue, nthValue, nullif, nullif, nullLiteral, or, or, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, overlay, pad, pad, pad, pad, pad, pad, pad, pad, pad, pad, pad, pad, parameter, parameter, percentileCont, percentileCont, percentileCont, percentileCont, percentileDisc, percentileDisc, percentileDisc, percentileDisc, percentRank, percentRank, percentRank, percentRank, percentRank, pi, power, power, prod, prod, prod, quot, quot, quot, radians, rank, rank, rank, rank, rank, replace, replace, replace, replace, right, right, round, rowNumber, search, search, search, second, selectCase, selectCase, sign, sin, sinh, size, size, some, sort, sort, sort, sql, sqrt, substring, substring, substring, substring, sum, sum, sum, sum, sum, sum, sum, sumAsDouble, sumAsLong, tan, tanh, toBigDecimal, toBigInteger, toDouble, toFloat, toInteger, toLong, toString, treat, treat, treat, treat, treat, treat, treat, trim, trim, trim, trim, trim, trim, truncate, truncate, tuple, tuple, union, union, union, union, unionAll, unionAll, unwrap, upper, value, value, values, values, windowFunction, wrap, wrap, year

Method Detail

eq

jakarta.persistence.criteria.Predicate eq(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                          jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially equal" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially equal" predicate

eq
```
jakarta.persistence.criteria.Predicate eq(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                          T geometry2)
```
Create a predicate for testing the arguments for "spatially equal" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially equal" predicate

See Also:

eq(Expression, Expression)

within

jakarta.persistence.criteria.Predicate within(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                              jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially within" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially within" predicate

within
```
jakarta.persistence.criteria.Predicate within(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                              T geometry2)
```
Create a predicate for testing the arguments for "spatially within" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially within" predicate

See Also:

within(Expression, Expression)

contains

jakarta.persistence.criteria.Predicate contains(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially contains" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially contains" predicate

contains
```
jakarta.persistence.criteria.Predicate contains(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                T geometry2)
```
Create a predicate for testing the arguments for "spatially contains" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially contains" predicate

See Also:

contains(Expression, Expression)

crosses

jakarta.persistence.criteria.Predicate crosses(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                               jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially crosses" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially crosses" predicate

crosses
```
jakarta.persistence.criteria.Predicate crosses(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                               T geometry2)
```
Create a predicate for testing the arguments for "spatially crosses" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially crosses" predicate

See Also:

crosses(Expression, Expression)

disjoint

jakarta.persistence.criteria.Predicate disjoint(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially disjoint" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially disjoint" predicate

disjoint
```
jakarta.persistence.criteria.Predicate disjoint(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                T geometry2)
```
Create a predicate for testing the arguments for "spatially disjoint" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially disjoint" predicate

See Also:

disjoint(Expression, Expression)

intersects

jakarta.persistence.criteria.Predicate intersects(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                  jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially intersects" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially intersects" predicate

intersects
```
jakarta.persistence.criteria.Predicate intersects(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                  T geometry2)
```
Create a predicate for testing the arguments for "spatially intersects" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially intersects" predicate

See Also:

intersects(Expression, Expression)

overlaps

jakarta.persistence.criteria.Predicate overlaps(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially overlaps" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially overlaps" predicate

overlaps
```
jakarta.persistence.criteria.Predicate overlaps(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                T geometry2)
```
Create a predicate for testing the arguments for "spatially overlaps" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially overlaps" predicate

See Also:

overlaps(Expression, Expression)

touches

jakarta.persistence.criteria.Predicate touches(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                               jakarta.persistence.criteria.Expression<? extends T> geometry2)

Create a predicate for testing the arguments for "spatially touches" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression
Returns:: "spatially touches" predicate

touches
```
jakarta.persistence.criteria.Predicate touches(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                               T geometry2)
```
Create a predicate for testing the arguments for "spatially touches" constraint.

Parameters:

geometry1 - geometry expression

geometry2 - geometry value

Returns:

"spatially touches" predicate

See Also:

touches(Expression, Expression)

distanceWithin

jakarta.persistence.criteria.Predicate distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                      jakarta.persistence.criteria.Expression<? extends T> geometry2,
                                                      jakarta.persistence.criteria.Expression<Double> distance)

Create a predicate for testing the arguments for "distance within" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression; distance - distance expression
Returns:: "distance within" predicate

distanceWithin

jakarta.persistence.criteria.Predicate distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                      T geometry2,
                                                      jakarta.persistence.criteria.Expression<Double> distance)

Create a predicate for testing the arguments for "distance within" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry value; distance - distance expression
Returns:: "distance within" predicate
See Also:: distanceWithin(Expression, Expression, Expression)

distanceWithin

jakarta.persistence.criteria.Predicate distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                      T geometry2,
                                                      double distance)

Create a predicate for testing the arguments for "distance within" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry value; distance - distance value
Returns:: "distance within" predicate
See Also:: distanceWithin(Expression, Expression, Expression)

distanceWithin

jakarta.persistence.criteria.Predicate distanceWithin(jakarta.persistence.criteria.Expression<? extends T> geometry1,
                                                      jakarta.persistence.criteria.Expression<? extends T> geometry2,
                                                      double distance)

Create a predicate for testing the arguments for "distance within" constraint.

Parameters:: geometry1 - geometry expression; geometry2 - geometry expression; distance - distance value
Returns:: "distance within" predicate
See Also:: distanceWithin(Expression, Expression, Expression)

havingSRID

jakarta.persistence.criteria.Predicate havingSRID(jakarta.persistence.criteria.Expression<? extends T> geometry,
                                                  jakarta.persistence.criteria.Expression<Integer> srid)

Create a predicate for testing the arguments for "having srid" constraint.

Parameters:: geometry - geometry expression; srid - SRID expression
Returns:: "having srid" predicate

havingSRID
```
jakarta.persistence.criteria.Predicate havingSRID(jakarta.persistence.criteria.Expression<? extends T> geometry,
                                                  int srid)
```
Create a predicate for testing the arguments for "having srid" constraint.

Parameters:

geometry - geometry expression

srid - SRID expression

Returns:

"having srid" predicate

See Also:

havingSRID(Expression, Expression)

isGeometryEmpty
```
jakarta.persistence.criteria.Predicate isGeometryEmpty(jakarta.persistence.criteria.Expression<? extends T> geometry)
```
Create a predicate for testing the arguments for "is empty" constraint.

Parameters:

geometry - geometry expression

Returns:

"is empty" predicate

isGeometryNotEmpty
```
jakarta.persistence.criteria.Predicate isGeometryNotEmpty(jakarta.persistence.criteria.Expression<? extends T> geometry)
```
Create a predicate for testing the arguments for "is not empty" constraint.

Parameters:

geometry - geometry expression

Returns:

"is not empty" predicate

Interface SpatialCriteriaBuilder<T>

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.persistence.criteria.CriteriaBuilder

Method Summary

Methods inherited from interface org.hibernate.query.criteria.HibernateCriteriaBuilder

Method Detail

eq

eq

within

within

contains

contains

crosses

crosses

disjoint

disjoint

intersects

intersects

overlaps

overlaps

touches

touches

distanceWithin

distanceWithin

distanceWithin

distanceWithin

havingSRID

havingSRID

isGeometryEmpty

isGeometryNotEmpty