/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.test.spatial;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import org.apache.lucene.search.Sort;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.hibernate.Transaction;
import org.hibernate.search.FullTextQuery;
import org.hibernate.search.FullTextSession;
import org.hibernate.search.Search;
import org.hibernate.search.exception.SearchException;
import org.hibernate.search.query.dsl.QueryBuilder;
import org.hibernate.search.query.dsl.Unit;
import org.hibernate.search.spatial.DistanceSortField;
import org.hibernate.search.test.SearchTestBase;
import org.hibernate.search.testsupport.TestForIssue;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* Hibernate Search spatial : unit tests on indexing POIs in with Grid and Grid+Distance
*
* @author Nicolas Helleringer <nicolas.helleringer@novacodex.net>
* @author Hardy Ferentschik
*/
public class SpatialIndexingTest extends SearchTestBase {
private FullTextSession fullTextSession;
@Before
public void createAndIndexTestData() throws Exception {
fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
// POI
fullTextSession.save( new POI( 1, "Distance to 24,32 : 0", 24.0d, 32.0d, "" ) );
fullTextSession.save( new POI( 2, "Distance to 24,32 : 10.16", 24.0d, 31.9d, "" ) );
fullTextSession.save( new POI( 3, "Distance to 24,32 : 11.12", 23.9d, 32.0d, "" ) );
fullTextSession.save( new POI( 4, "Distance to 24,32 : 15.06", 23.9d, 32.1d, "" ) );
fullTextSession.save( new POI( 5, "Distance to 24,32 : 22.24", 24.2d, 32.0d, "" ) );
fullTextSession.save( new POI( 6, "Distance to 24,32 : 24.45", 24.2d, 31.9d, "" ) );
// NonGeoPOI
fullTextSession.save( new NonGeoPOI( 1, "Distance to 24,32 : 0", 24.0d, null, "" ) );
fullTextSession.save( new NonGeoPOI( 2, "Distance to 24,32 : 24.45", 24.2d, 31.9d, "" ) );
fullTextSession.save( new NonGeoPOI( 3, "Distance to 24,32 : 10.16", 24.0d, 31.9d, "" ) );
fullTextSession.save( new NonGeoPOI( 4, "Distance to 24,32 : 15.06", 23.9d, 32.1d, "" ) );
fullTextSession.save( new NonGeoPOI( 5, "Distance to 24,32 : 11.12", 23.9d, 32.0d, "" ) );
fullTextSession.save( new NonGeoPOI( 6, "Distance to 24,32 : 22.24", 24.2d, 32.0d, "" ) );
// MissingSpatialPOI
fullTextSession.save( new MissingSpatialPOI( 1, "Distance to 24,32 : 0", 24.0d, 32.0d, "" ) );
// Event
SimpleDateFormat dateFormat = new SimpleDateFormat( "d M yyyy" );
Date date = dateFormat.parse( "10 9 1976" );
fullTextSession.save( new Event( 1, "Test", 24.0d, 32.0d, date ) );
// User
fullTextSession.save( new User( 1, 24.0d, 32.0d ) );
// UserRange
fullTextSession.save( new UserRange( 1, 24.0d, 32.0d ) );
// UserEx
fullTextSession.save( new UserEx( 1, 24.0d, 32.0d, 11.9d, 27.4d ) );
// RangeEvent
dateFormat = new SimpleDateFormat( "d M yyyy" );
date = dateFormat.parse( "10 9 1976" );
fullTextSession.save( new RangeEvent( 1, "Test", 24.0d, 32.0d, date ) );
// Hotel
fullTextSession.save( new Hotel( 1, "Plazza Athénée", 24.0d, 32.0d, "Luxurious" ) );
// RangeHotel
fullTextSession.save( new RangeHotel( 1, "Plazza Athénée", 24.0d, 32.0d, "Luxurious" ) );
fullTextSession.save( new RangeHotel( 2, "End of the world Hotel - Left", 0.0d, 179.0d, "Roots" ) );
fullTextSession.save( new RangeHotel( 3, "End of the world Hotel - Right", 0.0d, -179.0d, "Cosy" ) );
// Restaurant
fullTextSession.save(
new Restaurant( 1, "Al's kitchen", "42, space avenue CA8596 BYOB Street", 24.0d, 32.0d )
);
// GetterUser
fullTextSession.save( new GetterUser( 1, 24.0d, 32.0d ) );
tx.commit();
}
@Test
public void testIndexing() throws Exception {
double centerLatitude = 24;
double centerLongitude = 32;
assertNumberOfPointsOfInterestWithinRadius( centerLatitude, centerLongitude, 0, 1 );
assertNumberOfPointsOfInterestWithinRadius( centerLatitude, centerLongitude, 10, 1 );
assertNumberOfPointsOfInterestWithinRadius( centerLatitude, centerLongitude, 20, 4 );
assertNumberOfPointsOfInterestWithinRadius( centerLatitude, centerLongitude, 30, 6 );
}
@Test
public void testDistanceProjection() throws Exception {
double centerLatitude = 24.0d;
double centerLongitude = 32.0d;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( POI.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( 100, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
FullTextQuery hibQuery = fullTextSession.createFullTextQuery( luceneQuery, POI.class );
hibQuery.setProjection( FullTextQuery.THIS, FullTextQuery.SPATIAL_DISTANCE );
hibQuery.setSpatialParameters( centerLatitude, centerLongitude, "location" );
List results = hibQuery.list();
Object[] firstResult = (Object[]) results.get( 0 );
Object[] secondResult = (Object[]) results.get( 1 );
Object[] thirdResult = (Object[]) results.get( 2 );
Object[] fourthResult = (Object[]) results.get( 3 );
Object[] fifthResult = (Object[]) results.get( 4 );
Object[] sixthResult = (Object[]) results.get( 5 );
Assert.assertEquals( ( (Double) firstResult[1] ), 0.0, 0.0001 );
Assert.assertEquals( ( (Double) secondResult[1] ), 10.1582, 0.0001 );
Assert.assertEquals( ( (Double) thirdResult[1] ), 11.1195, 0.0001 );
Assert.assertEquals( ( (Double) fourthResult[1] ), 15.0636, 0.0001 );
Assert.assertEquals( ( (Double) fifthResult[1] ), 22.239, 0.001 );
Assert.assertEquals( ( (Double) sixthResult[1] ), 24.446, 0.001 );
}
@Test
public void testDistanceSort() throws Exception {
double centerLatitude = 24.0d;
double centerLongitude = 32.0d;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( POI.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( 100, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
FullTextQuery hibQuery = fullTextSession.createFullTextQuery( luceneQuery, POI.class );
Sort distanceSort = new Sort( new DistanceSortField( centerLatitude, centerLongitude, "location" ) );
hibQuery.setSort( distanceSort );
hibQuery.setProjection( FullTextQuery.THIS, FullTextQuery.SPATIAL_DISTANCE );
hibQuery.setSpatialParameters( centerLatitude, centerLongitude, "location" );
List<Object[]> results = hibQuery.list();
Double previousDistance = (Double) results.get( 0 )[1];
for ( int i = 1; i < results.size(); i++ ) {
Object[] projectionEntry = results.get( i );
Double currentDistance = (Double) projectionEntry[1];
assertTrue( previousDistance + " should be < " + currentDistance, previousDistance < currentDistance );
previousDistance = currentDistance;
}
}
@Test
@Ignore
@TestForIssue(jiraKey = "HSEARCH-1708")
public void testNonGeoDistanceSort() throws Exception {
double centerLatitude = 24.0d;
double centerLongitude = 32.0d;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( NonGeoPOI.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.all().createQuery();
FullTextQuery hibQuery = fullTextSession.createFullTextQuery( luceneQuery, NonGeoPOI.class );
Sort distanceSort = new Sort( new DistanceSortField( centerLatitude, centerLongitude, "location" ) );
hibQuery.setSort( distanceSort );
hibQuery.setProjection( FullTextQuery.THIS, FullTextQuery.SPATIAL_DISTANCE );
hibQuery.setSpatialParameters( centerLatitude, centerLongitude, "location" );
// TODO - unclear what this should to. See HSEARCH-1708. ATM the calculated distance is the same for all points.
hibQuery.list();
}
@Test
@TestForIssue(jiraKey = "HSEARCH-1470")
public void testSpatialQueryOnNonSpatialConfiguredEntityThrowsException() throws Exception {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( MissingSpatialPOI.class ).get();
try {
builder.spatial()
.onDefaultCoordinates()
.within( 1, Unit.KM )
.ofLatitude( 0d )
.andLongitude( 0d )
.createQuery();
fail( "Building an invalid spatial query should fail" );
}
catch (SearchException e) {
assertTrue( "Wrong error message: " + e.getMessage(), e.getMessage().startsWith( "HSEARCH000131" ) );
}
}
@Test
@TestForIssue(jiraKey = "HSEARCH-1470")
public void testSpatialQueryOnWrongFieldThrowsException() throws Exception {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( POI.class ).get();
try {
builder.spatial()
.onCoordinates( "foo" )
.within( 1, Unit.KM )
.ofLatitude( 0d )
.andLongitude( 0d )
.createQuery();
fail( "Building an invalid spatial query should fail" );
}
catch (SearchException e) {
assertTrue( "Wrong error message " + e.getMessage(), e.getMessage().startsWith( "HSEARCH000131" ) );
}
}
@Test
public void testSpatialAnnotationOnFieldLevel() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( Event.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, Event.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "location" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, Event.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialAnnotationWithSubAnnotationsLevel() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( User.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "home" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, User.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "home" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, User.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialAnnotationWithSubAnnotationsLevelRangeMode() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( UserRange.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onDefaultCoordinates()
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, UserRange.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onDefaultCoordinates()
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, UserRange.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialsAnnotation() throws Exception {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( UserEx.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onDefaultCoordinates()
.within( 100.0d, Unit.KM ).ofLatitude( 24.0d ).andLongitude( 31.5d ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, UserEx.class );
List results = hibQuery.list();
Assert.assertEquals( 1, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "work" )
.within( 100.0d, Unit.KM ).ofLatitude( 12.0d ).andLongitude( 27.5d ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, UserEx.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialAnnotationOnFieldLevelRangeMode() throws Exception {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( RangeEvent.class ).get();
double centerLatitude = 24;
double centerLongitude = 31.5;
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, RangeEvent.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "location" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, RangeEvent.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialAnnotationOnClassLevel() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( Hotel.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "hotel_location" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, Hotel.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "hotel_location" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, Hotel.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialAnnotationOnClassLevelRangeMode() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( RangeHotel.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, RangeHotel.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "location" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, RangeHotel.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
double endOfTheWorldLatitude = 0.0d;
double endOfTheWorldLongitude = 180.0d;
org.apache.lucene.search.Query luceneQuery3 = builder.spatial()
.onCoordinates( "location" )
.within( 112, Unit.KM )
.ofLatitude( endOfTheWorldLatitude )
.andLongitude( endOfTheWorldLongitude )
.createQuery();
org.hibernate.Query hibQuery3 = fullTextSession.createFullTextQuery( luceneQuery3, RangeHotel.class );
List results3 = hibQuery3.list();
Assert.assertEquals( 2, results3.size() );
org.apache.lucene.search.Query luceneQuery4 = builder.spatial()
.onCoordinates( "location" )
.within( 100000, Unit.KM )
.ofLatitude( endOfTheWorldLatitude )
.andLongitude( endOfTheWorldLongitude )
.createQuery();
org.hibernate.Query hibQuery4 = fullTextSession.createFullTextQuery( luceneQuery4, RangeHotel.class );
List results4 = hibQuery4.list();
Assert.assertEquals( 3, results4.size() );
}
@Test
public void testSpatialAnnotationOnEmbeddableFieldLevel() throws Exception {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( Restaurant.class ).get();
double centerLatitude = 24;
double centerLongitude = 31.5;
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "position.location" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, Restaurant.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "position.location" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, Restaurant.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Test
public void testSpatialLatLongOnGetters() throws Exception {
//Point center = Point.fromDegrees( 24, 31.5 ); // 50.79 km fromBoundingCircle 24.32
double centerLatitude = 24;
double centerLongitude = 31.5;
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( GetterUser.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "home" )
.within( 50, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, GetterUser.class );
List results = hibQuery.list();
Assert.assertEquals( 0, results.size() );
org.apache.lucene.search.Query luceneQuery2 = builder.spatial().onCoordinates( "home" )
.within( 51, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery2 = fullTextSession.createFullTextQuery( luceneQuery2, GetterUser.class );
List results2 = hibQuery2.list();
Assert.assertEquals( 1, results2.size() );
}
@Override
protected Class<?>[] getAnnotatedClasses() {
return new Class<?>[] {
POI.class,
Event.class,
Hotel.class,
User.class,
UserRange.class,
UserEx.class,
RangeHotel.class,
RangeEvent.class,
Restaurant.class,
NonGeoPOI.class,
GetterUser.class,
MissingSpatialPOI.class
};
}
private void assertNumberOfPointsOfInterestWithinRadius(double centerLatitude,
double centerLongitude,
double radius,
int expectedPoiCount) {
final QueryBuilder builder = fullTextSession.getSearchFactory()
.buildQueryBuilder().forEntity( POI.class ).get();
org.apache.lucene.search.Query luceneQuery = builder.spatial().onCoordinates( "location" )
.within( radius, Unit.KM ).ofLatitude( centerLatitude ).andLongitude( centerLongitude ).createQuery();
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( luceneQuery, POI.class );
List results = hibQuery.list();
Assert.assertEquals( "Unexpected number of POIs within radius", expectedPoiCount, results.size() );
}
}