All Superinterfaces:

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
  CriteriaBuilder.Case<R extends Object>, CriteriaBuilder.Coalesce<T extends Object>, CriteriaBuilder.In<T extends Object>, CriteriaBuilder.SimpleCase<C extends Object,R extends Object>, CriteriaBuilder.Trimspec

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Predicate`	`contains(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially contains" constraint.
`Predicate`	`contains(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially contains" constraint.
`Predicate`	`crosses(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially crosses" constraint.
`Predicate`	`crosses(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially crosses" constraint.
`Predicate`	`disjoint(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially disjoint" constraint.
`Predicate`	`disjoint(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially disjoint" constraint.
`Predicate`	`distanceWithin(Expression<? extends T> geometry1, Expression<? extends T> geometry2, double distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`Predicate`	`distanceWithin(Expression<? extends T> geometry1, Expression<? extends T> geometry2, Expression<Double> distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`Predicate`	`distanceWithin(Expression<? extends T> geometry1, T geometry2, double distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`Predicate`	`distanceWithin(Expression<? extends T> geometry1, T geometry2, Expression<Double> distance)`	Create a predicate for testing the arguments for "distance within" constraint.
`Predicate`	`eq(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially equal" constraint.
`Predicate`	`eq(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially equal" constraint.
`Predicate`	`havingSRID(Expression<? extends T> geometry, int srid)`	Create a predicate for testing the arguments for "having srid" constraint.
`Predicate`	`havingSRID(Expression<? extends T> geometry, Expression<Integer> srid)`	Create a predicate for testing the arguments for "having srid" constraint.
`Predicate`	`intersects(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially intersects" constraint.
`Predicate`	`intersects(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially intersects" constraint.
`Predicate`	`isGeometryEmpty(Expression<? extends T> geometry)`	Create a predicate for testing the arguments for "is empty" constraint.
`Predicate`	`isGeometryNotEmpty(Expression<? extends T> geometry)`	Create a predicate for testing the arguments for "is not empty" constraint.
`Predicate`	`overlaps(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially overlaps" constraint.
`Predicate`	`overlaps(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially overlaps" constraint.
`Predicate`	`touches(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially touches" constraint.
`Predicate`	`touches(Expression<? extends T> geometry1, T geometry2)`	Create a predicate for testing the arguments for "spatially touches" constraint.
`Predicate`	`within(Expression<? extends T> geometry1, Expression<? extends T> geometry2)`	Create a predicate for testing the arguments for "spatially within" constraint.
`Predicate`	`within(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, addDuration, addDuration, addDuration, all, and, and, any, array, array, array, array, arrayAgg, arrayAgg, arrayAgg, arrayAgg, arrayAppend, arrayAppend, arrayConcat, arrayConcat, arrayConcat, arrayContains, arrayContains, arrayContains, arrayContainsAll, arrayContainsAll, arrayContainsAll, arrayContainsAllNullable, arrayContainsAllNullable, arrayContainsAllNullable, arrayContainsNullable, arrayContainsNullable, arrayContainsNullable, arrayFill, arrayFill, arrayFill, arrayFill, arrayGet, arrayGet, arrayLength, arrayLiteral, arrayOverlaps, arrayOverlaps, arrayOverlaps, arrayOverlapsNullable, arrayOverlapsNullable, arrayOverlapsNullable, arrayPosition, arrayPosition, arrayPositions, arrayPositions, arrayPositionsList, arrayPositionsList, arrayPrepend, arrayPrepend, arrayRemove, arrayRemove, arrayRemoveIndex, arrayRemoveIndex, arrayReplace, arrayReplace, arrayReplace, arrayReplace, arraySet, arraySet, arraySet, arraySet, arraySlice, arraySlice, arraySlice, arraySlice, arrayToString, arrayToString, arrayTrim, arrayTrim, asc, asc, asc, asc, asin, atan, atan2, atan2, atan2, avg, avg, avg, avg, between, between, cast, ceiling, coalesce, coalesce, coalesce, collate, collectionAppend, collectionAppend, collectionConcat, collectionConcat, collectionConcat, collectionContains, collectionContains, collectionContains, collectionContainsAll, collectionContainsAll, collectionContainsAll, collectionContainsAllNullable, collectionContainsAllNullable, collectionContainsAllNullable, collectionContainsNullable, collectionContainsNullable, collectionContainsNullable, collectionFill, collectionFill, collectionFill, collectionFill, collectionGet, collectionGet, collectionLength, collectionLiteral, collectionOverlaps, collectionOverlaps, collectionOverlaps, collectionOverlapsNullable, collectionOverlapsNullable, collectionOverlapsNullable, collectionPosition, collectionPosition, collectionPositions, collectionPositions, collectionPositionsList, collectionPositionsList, collectionPrepend, collectionPrepend, collectionRemove, collectionRemove, collectionRemoveIndex, collectionRemoveIndex, collectionReplace, collectionReplace, collectionReplace, collectionReplace, collectionSet, collectionSet, collectionSet, collectionSet, collectionSlice, collectionSlice, collectionSlice, collectionSlice, collectionToString, collectionToString, collectionTrim, collectionTrim, concat, concat, concat, concat, conjunction, construct, construct, cos, cosh, count, count, count, count, count, countDistinct, createCriteriaDelete, createCriteriaInsertSelect, createCriteriaInsertValues, createCriteriaUpdate, createQuery, createQuery, createQuery, createTupleQuery, createWindow, cumeDist, currentDate, currentInstant, currentTime, currentTimestamp, day, degrees, denseRank, desc, desc, desc, desc, diff, diff, diff, disjunction, distinctFrom, distinctFrom, duration, durationBetween, durationBetween, durationByUnit, durationDiff, durationDiff, durationScaled, durationScaled, durationScaled, durationSum, durationSum, 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, 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, repeat, repeat, repeat, replace, replace, replace, replace, right, right, round, rowNumber, search, search, search, second, selectCase, selectCase, sign, sin, sinh, size, size, some, sort, sort, sort, sort, sql, sqrt, substring, substring, substring, substring, subtractDuration, subtractDuration, subtractDuration, 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, values, values, values, windowFunction, wrap, wrap, year

- Method Detail
  - eq
```
Predicate eq(Expression<? extends T> geometry1,
             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
```
Predicate eq(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
```
Predicate within(Expression<? extends T> geometry1,
                 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
```
Predicate within(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
```
Predicate contains(Expression<? extends T> geometry1,
                   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
```
Predicate contains(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
```
Predicate crosses(Expression<? extends T> geometry1,
                  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
```
Predicate crosses(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
```
Predicate disjoint(Expression<? extends T> geometry1,
                   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
```
Predicate disjoint(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
```
Predicate intersects(Expression<? extends T> geometry1,
                     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
```
Predicate intersects(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
```
Predicate overlaps(Expression<? extends T> geometry1,
                   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
```
Predicate overlaps(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
```
Predicate touches(Expression<? extends T> geometry1,
                  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
```
Predicate touches(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
```
Predicate distanceWithin(Expression<? extends T> geometry1,
                         Expression<? extends T> geometry2,
                         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
```
Predicate distanceWithin(Expression<? extends T> geometry1,
                         T geometry2,
                         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
```
Predicate distanceWithin(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
```
Predicate distanceWithin(Expression<? extends T> geometry1,
                         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
```
Predicate havingSRID(Expression<? extends T> geometry,
                     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
```
Predicate havingSRID(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
```
Predicate isGeometryEmpty(Expression<? extends T> geometry)
```
    Create a predicate for testing the arguments for "is empty" constraint.
    
    Parameters:
    
    geometry - geometry expression
    
    Returns:
    
    "is empty" predicate
  - isGeometryNotEmpty
```
Predicate isGeometryNotEmpty(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