org.hibernate.search.mapper.pojo.bridge.builtin.programmatic

Interface GeoPointBinder

All Superinterfaces:

PropertyBinder<GeoPointBinding>, TypeBinder<GeoPointBinding>

public interface GeoPointBinder
extends TypeBinder<GeoPointBinding>, PropertyBinder<GeoPointBinding>

A binder from a type or property to a GeoPoint field, representing a point on earth.

These fields allow spatial predicates such as "within" (is the point within a circle, a bounding box, ...), sorts by distance to another point, ...

See Also:

GeoPointBinding, create(), latitude(), longitude()

Method Summary

Modifier and Type	Method and Description
static GeoPointBinder	create()
GeoPointBinder	fieldName(String fieldName)
default void	initialize(GeoPointBinding annotation) Initializes the parameters of this binder with the attributes of the given annotation.
static LatitudeLongitudeMarkerBinder	latitude()
static LatitudeLongitudeMarkerBinder	longitude()
GeoPointBinder	markerSet(String markerSet)
GeoPointBinder	projectable(Projectable projectable)
GeoPointBinder	sortable(Sortable sortable)

Methods inherited from interface org.hibernate.search.mapper.pojo.bridge.mapping.programmatic.TypeBinder

bind

Methods inherited from interface org.hibernate.search.mapper.pojo.bridge.mapping.programmatic.PropertyBinder

bind

Method Detail

fieldName

GeoPointBinder fieldName(String fieldName)

Parameters:

fieldName - The name of the GeoPoint field. If used on a property, this defaults to the name of that property. Otherwise, the name must be defined explicitly.

Returns:

this, for method chaining.

projectable

GeoPointBinder projectable(Projectable projectable)

Parameters:

projectable - Whether projections are enabled for the GeoPoint field.

Returns:

this, for method chaining.

See Also:

GenericField.projectable(), Projectable

sortable

GeoPointBinder sortable(Sortable sortable)

Parameters:

sortable - Whether the GeoPoint field should be sortable by distance.

Returns:

this, for method chaining.

See Also:

GenericField.sortable(), Sortable

markerSet

GeoPointBinder markerSet(String markerSet)

Parameters:

markerSet - The name of the "marker set". This is used to discriminate between multiple pairs of latitude/longitude markers: assign a marker set when building each marker, then select the marker set here.

Returns:

this, for method chaining.

initialize

default void initialize(GeoPointBinding annotation)

Description copied from interface: TypeBinder

Initializes the parameters of this binder with the attributes of the given annotation.

Specified by:

initialize in interface PropertyBinder<GeoPointBinding>

Specified by:

initialize in interface TypeBinder<GeoPointBinding>

Parameters:

annotation - An annotation to extract parameters from.

create

static GeoPointBinder create()

Returns:

A GeoPointBinder.

latitude

static LatitudeLongitudeMarkerBinder latitude()

Returns:

A MarkerBinder for the latitude, to be applied on a property.

See Also:

LatitudeLongitudeMarkerBinder

longitude

static LatitudeLongitudeMarkerBinder longitude()

Returns:

A MarkerBinder for the longitude, to be applied on a property.

See Also:

LatitudeLongitudeMarkerBinder