org.hibernate.search.annotations
Annotation Type Spatial

@Retention(value=RUNTIME)
@Target(value={METHOD,FIELD,TYPE})
@Documented
public @interface Spatial

Defines a spatial property. Spatial coordinates can be indexed as latitude / longitude fields and queried via range queries. This is known as the SpatialMode.RANGE approach. Otherwise, they can be indexed using a quad-tree index. This is known as the

Author:

Nicolas Helleringer (nicolas.helleringer@novacodex.net)

Optional Element Summary

Boost	boost
int	bottomQuadTreeLevel
String	name The name of the field prefix where spatial index information is stored in a Lucene document.
SpatialMode	spatialMode
Store	store
int	topQuadTreeLevel

name

public abstract String name

The name of the field prefix where spatial index information is stored in a Lucene document. If @Spatial is hosted on a property, defaults to the property name.

Returns:

the field name

Default:

""

store

public abstract Store store

Returns:

Returns an instance of the Store enum, indicating whether the value should be stored in the document. Defaults to Store.NO

Default:

org.hibernate.search.annotations.Store.NO

boost

public abstract Boost boost

Returns:

Returns a Boost annotation defining a float index time boost value

Default:

@org.hibernate.search.annotations.Boost(1.0f)

spatialMode

public abstract SpatialMode spatialMode

Returns:

the mode used for Spatial indexing

Default:

org.hibernate.search.annotations.SpatialMode.RANGE

topQuadTreeLevel

public abstract int topQuadTreeLevel

Returns:

top range quad tree level for spatial indexing

Default:

0

bottomQuadTreeLevel

public abstract int bottomQuadTreeLevel

Returns:

bottom quad tree level for spatial indexing

Default:

16