org.hibernate.search.spatial

Class SpatialFieldBridgeByHash

java.lang.Object

org.hibernate.search.spatial.SpatialFieldBridge

org.hibernate.search.spatial.SpatialFieldBridgeByHash

All Implemented Interfaces:

FieldBridge, MetadataProvidingFieldBridge, ParameterizedBridge

public class SpatialFieldBridgeByHash
extends SpatialFieldBridge
implements ParameterizedBridge

Hibernate Search field bridge, binding a Coordinates to a spatial hash field in the index

Author:

Nicolas Helleringer

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BOTTOM_SPATIAL_HASH_LEVEL
static int	DEFAULT_TOP_SPATIAL_HASH_LEVEL

Fields inherited from class org.hibernate.search.spatial.SpatialFieldBridge

latitudeField, latitudeIndexedFieldName, longitudeField, longitudeIndexedFieldName

Constructor Summary

Constructors

Constructor and Description
SpatialFieldBridgeByHash()
SpatialFieldBridgeByHash(int topSpatialHashLevel, int bottomSpatialHashLevel)
SpatialFieldBridgeByHash(int topSpatialHashLevel, int bottomSpatialHashLevel, String latitudeField, String longitudeField)

Method Summary

Modifier and Type	Method and Description
void	configureFieldMetadata(String name, FieldMetadataBuilder builder) Allows this bridge to expose meta-data about the fields it creates.
void	set(String name, Object value, Document document, LuceneOptions luceneOptions) Actual overridden method that does the indexing
void	setParameterValues(Map parameters) Override method for default min and max spatial hash level

Methods inherited from class org.hibernate.search.spatial.SpatialFieldBridge

capitalize, getLatitude, getLongitude

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TOP_SPATIAL_HASH_LEVEL

public static final int DEFAULT_TOP_SPATIAL_HASH_LEVEL

See Also:

Constant Field Values

DEFAULT_BOTTOM_SPATIAL_HASH_LEVEL

public static final int DEFAULT_BOTTOM_SPATIAL_HASH_LEVEL

See Also:

Constant Field Values

Constructor Detail

SpatialFieldBridgeByHash

public SpatialFieldBridgeByHash()

SpatialFieldBridgeByHash

public SpatialFieldBridgeByHash(int topSpatialHashLevel,
                                int bottomSpatialHashLevel)

SpatialFieldBridgeByHash

public SpatialFieldBridgeByHash(int topSpatialHashLevel,
                                int bottomSpatialHashLevel,
                                String latitudeField,
                                String longitudeField)

Method Detail

configureFieldMetadata

public void configureFieldMetadata(String name,
                                   FieldMetadataBuilder builder)

Description copied from interface: MetadataProvidingFieldBridge

Allows this bridge to expose meta-data about the fields it creates.

Specified by:

configureFieldMetadata in interface MetadataProvidingFieldBridge

Overrides:

configureFieldMetadata in class SpatialFieldBridge

Parameters:

name - The default field name; Should be used consistently with FieldBridge.set(String, Object, org.apache.lucene.document.Document, LuceneOptions).

builder - Builder for exposing field-related meta-data

set

public void set(String name,
                Object value,
                Document document,
                LuceneOptions luceneOptions)

Actual overridden method that does the indexing

Specified by:

set in interface FieldBridge

Specified by:

set in class SpatialFieldBridge

Parameters:

name - of the field

value - of the field

document - document being indexed

luceneOptions - current indexing options and accessors

setParameterValues

public void setParameterValues(Map parameters)

Override method for default min and max spatial hash level

Specified by:

setParameterValues in interface ParameterizedBridge

Parameters:

parameters - Map containing the topSpatialHashLevel and bottomSpatialHashLevel values