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

Interface SpatialWithinPredicateAreaStep<N extends SpatialWithinPredicateOptionsStep<?>>

Type Parameters:

N - The type of the next step.

All Known Subinterfaces:

SpatialWithinPredicateFieldMoreStep<S,N>

public interface SpatialWithinPredicateAreaStep<N extends SpatialWithinPredicateOptionsStep<?>>

The step in a "within" predicate definition where the area to match can be set.

Method Summary

Modifier and Type	Method	Description
default N	boundingBox(double topLeftLatitude, double topLeftLongitude, double bottomRightLatitude, double bottomRightLongitude)	Require at least one of the targeted fields to point to a location within the given box (~rectangle).
N	boundingBox(GeoBoundingBox boundingBox)	Require at least one of the targeted fields to point to a location within the given box (~rectangle).
default N	circle(double latitude, double longitude, double radiusInMeters)	Require at least one of the targeted fields to point to a location within the given circle, i.e.
default N	circle(double latitude, double longitude, double radius, DistanceUnit unit)	Require at least one of the targeted fields to point to a location within the given circle, i.e.
default N	circle(GeoPoint center, double radiusInMeters)	Require at least one of the targeted fields to point to a location within the given circle, i.e.
N	circle(GeoPoint center, double radius, DistanceUnit unit)	Require at least one of the targeted fields to point to a location within the given circle, i.e.
N	polygon(GeoPolygon polygon)	Require at least one of the targeted fields to point to a location within the given polygon.

Method Detail

circle

N circle(GeoPoint center,
         double radius,
         DistanceUnit unit)

Require at least one of the targeted fields to point to a location within the given circle, i.e. a location that is at most at the given distance from the given center.

Parameters:

center - The center of the bounding circle.

radius - The radius of the bounding circle, in the unit defined by parameter unit.

unit - The unit used for the radius.

Returns:

The next step.

circle

default N circle(GeoPoint center,
                 double radiusInMeters)

Require at least one of the targeted fields to point to a location within the given circle, i.e. a location that is at most at the given distance from the given center.

Parameters:

center - The center of the bounding circle.

radiusInMeters - The radius of the bounding circle, in meters.

Returns:

The next step.

circle

default N circle(double latitude,
                 double longitude,
                 double radius,
                 DistanceUnit unit)

Require at least one of the targeted fields to point to a location within the given circle, i.e. a location that is at most at the given distance from the given center.

Parameters:

latitude - The latitude of the center of the bounding circle.

longitude - The longitude of the center of the bounding circle.

radius - The radius of the bounding circle, in the unit defined by parameter unit.

unit - The unit used for the radius.

Returns:

The next step.

circle

default N circle(double latitude,
                 double longitude,
                 double radiusInMeters)

Require at least one of the targeted fields to point to a location within the given circle, i.e. a location that is at most at the given distance from the given center.

Parameters:

latitude - The latitude of the center of the bounding circle.

longitude - The longitude of the center of the bounding circle.

radiusInMeters - The radius of the bounding circle, in meters.

Returns:

The next step.

polygon

N polygon(GeoPolygon polygon)

Require at least one of the targeted fields to point to a location within the given polygon.

Parameters:

polygon - The bounding polygon.

Returns:

The next step.

boundingBox

N boundingBox(GeoBoundingBox boundingBox)

Require at least one of the targeted fields to point to a location within the given box (~rectangle).

Parameters:

boundingBox - The bounding box.

Returns:

The next step.

boundingBox

default N boundingBox(double topLeftLatitude,
                      double topLeftLongitude,
                      double bottomRightLatitude,
                      double bottomRightLongitude)

Require at least one of the targeted fields to point to a location within the given box (~rectangle).

Parameters:

topLeftLatitude - The latitude of the top-left corner of the box.

topLeftLongitude - The longitude of the top-left corner of the box.

bottomRightLatitude - The latitude of the bottom-right corner of the box.

bottomRightLongitude - The longitude of the bottom-right corner of the box.

Returns:

The next step.