/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* JBoss, Home of Professional Open Source
* Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
* as indicated by the @authors tag. All rights reserved.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
package org.hibernate.search.spatial;
import org.apache.lucene.document.Document;
import org.hibernate.search.bridge.FieldBridge;
import org.hibernate.search.bridge.LuceneOptions;
import org.hibernate.search.bridge.ParameterizedBridge;
import org.hibernate.search.spatial.impl.GridHelper;
import org.hibernate.search.spatial.impl.Point;
import java.util.Map;
/**
* Hibernate Search field bridge, binding a Coordinates to Grid field in the index
*
* @author Nicolas Helleringer <nicolas.helleringer@novacodex.net>
*/
public class SpatialFieldBridgeByGrid implements FieldBridge, ParameterizedBridge {
public static final int DEFAULT_TOP_GRID_LEVEL = 0;
public static final int DEFAULT_BOTTOM_GRID_LEVEL = 16;
private int topGridLevel = DEFAULT_TOP_GRID_LEVEL;
private int bottomGridLevel = DEFAULT_BOTTOM_GRID_LEVEL;
private boolean gridIndex = true;
private boolean numericFieldsIndex = true;
public SpatialFieldBridgeByGrid() {}
public SpatialFieldBridgeByGrid(int topGridLevel, int bottomGridLevel) {
this.topGridLevel = topGridLevel;
this.bottomGridLevel = bottomGridLevel;
}
/**
* Actual overridden method that does the indexing
*
* @param name of the field
* @param value of the field
* @param document document being indexed
* @param luceneOptions current indexing options and accessors
*/
@Override
public void set(String name, Object value, Document document, LuceneOptions luceneOptions) {
if ( value != null ) {
Coordinates coordinates = (Coordinates) value;
Double latitude = coordinates.getLatitude();
Double longitude = coordinates.getLongitude();
if( ( latitude != null ) && ( longitude != null ) ) {
if( gridIndex ) {
Point point = Point.fromDegrees( latitude, longitude );
for ( int i = topGridLevel; i <= bottomGridLevel; i++ ) {
luceneOptions.addFieldToDocument( GridHelper.formatFieldName( i, name ), GridHelper.getGridCellId( point, i), document );
}
}
if( numericFieldsIndex ) {
luceneOptions.addNumericFieldToDocument(
GridHelper.formatLatitude( name ),
latitude,
document
);
luceneOptions.addNumericFieldToDocument(
GridHelper.formatLongitude( name ),
longitude,
document
);
}
}
}
}
/**
* Override method for default min and max grid level
*
* @param parameters Map containing the topGridLevel and bottomGridLevel values
*/
@Override
public void setParameterValues(Map parameters) {
Object topGridLevel = parameters.get( "topGridLevel" );
if ( topGridLevel instanceof Integer ) {
this.topGridLevel = ( Integer ) topGridLevel;
}
Object bottomGridLevel = parameters.get( "bottomGridLevel" );
if ( bottomGridLevel instanceof Integer ) {
this.bottomGridLevel = ( Integer ) bottomGridLevel;
}
Object gridIndex = parameters.get( "gridIndex" );
if ( gridIndex instanceof Boolean ) {
this.gridIndex = ( Boolean ) gridIndex;
}
Object numericFieldsIndex = parameters.get( "numericFieldsIndex" );
if ( numericFieldsIndex instanceof Boolean ) {
this.numericFieldsIndex = ( Boolean ) numericFieldsIndex;
}
}
}