/*
* 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.query;
import java.util.Iterator;
import java.util.List;
import org.apache.lucene.queryparser.classic.QueryParser;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;
import org.hibernate.FetchMode;
import org.hibernate.ScrollableResults;
import org.hibernate.Transaction;
import org.hibernate.search.FullTextQuery;
import org.hibernate.search.FullTextSession;
import org.hibernate.search.Search;
import org.hibernate.search.test.SearchTestBase;
import org.hibernate.search.testsupport.TestConstants;
import org.hibernate.search.hcore.util.impl.HibernateHelper;
import org.hibernate.stat.Statistics;
import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
/**
* @author Emmanuel Bernard
* @author John Griffin
* @author Hardy Ferentschik
*/
public class LuceneQueryTest extends SearchTestBase {
@Override
@Before
public void setUp() throws Exception {
super.setUp();
indexTestData();
}
@Test
public void testList() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:noword" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( 0, result.size() );
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with explicit class filter", 2, result.size() );
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with one class filter", 1, result.size() );
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with no class filter", 2, result.size() );
for ( Object element : result ) {
assertTrue( HibernateHelper.isInitialized( element ) );
fullTextSession.delete( element );
}
fullTextSession.flush();
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with delete objects", 0, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testResultSize() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina Or brand:Seiko" );
Statistics stats = fullTextSession.getSessionFactory().getStatistics();
stats.clear();
boolean enabled = stats.isStatisticsEnabled();
if ( !enabled ) {
stats.setStatisticsEnabled( true );
}
FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
assertEquals( "Exection of getResultSize without actual results", 2, hibQuery.getResultSize() );
assertEquals( "No entity should be loaded", 0, stats.getEntityLoadCount() );
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "2 entities should be loaded", 2, stats.getEntityLoadCount() );
if ( !enabled ) {
stats.setStatisticsEnabled( false );
}
tx.commit();
fullTextSession.close();
}
@Test
public void testResultSizeWithOffset() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina Or brand:Seiko" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
hibQuery.setFirstResult( 1 );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "first result no max result", 1, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testMaxResultLessThanTotalNumberOfHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina Or brand:Seiko" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
hibQuery.setFirstResult( 0 );
hibQuery.setMaxResults( 1 );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "max result set", 1, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testMaxResultMoreThanTotalNumberOfHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina Or brand:Seiko" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
hibQuery.setFirstResult( 0 );
hibQuery.setMaxResults( 3 );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "max result out of limit", 2, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testMaxResultWithOffset() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina Or brand:Seiko" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
hibQuery.setFirstResult( 2 );
hibQuery.setMaxResults( 3 );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "first result out of limit", 0, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testIterator() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:noword" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
Iterator result = hibQuery.iterate();
assertNotNull( result );
assertFalse( result.hasNext() );
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
result = hibQuery.iterate();
assertNotNull( result );
int index = 0;
while ( result.hasNext() ) {
index++;
fullTextSession.delete( result.next() );
}
assertEquals( 2, index );
fullTextSession.flush();
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
result = hibQuery.iterate();
assertNotNull( result );
assertFalse( result.hasNext() );
tx.commit();
fullTextSession.close();
}
@Test
public void testScrollableResultSet() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:noword" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
ScrollableResults result = hibQuery.scroll();
assertNotNull( result );
assertEquals( -1, result.getRowNumber() );
assertEquals( false, result.next() );
result.close();
query = parser.parse( "summary:Festina Or brand:Seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
result = hibQuery.scroll();
assertEquals( -1, result.getRowNumber() );
result.beforeFirst();
assertEquals( true, result.next() );
assertTrue( result.isFirst() );
assertTrue( result.scroll( 1 ) );
assertTrue( result.isLast() );
assertFalse( result.scroll( 1 ) );
tx.commit();
fullTextSession.close();
}
// Technically this is checked by other tests but let's do it anyway. J.G.
@Test
public void testDefaultFetchSize() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:ITech" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setProjection( "id", "lastname", "dept" );
ScrollableResults projections = hibQuery.scroll();
projections.beforeFirst();
Object[] projection = projections.get();
assertNull( projection );
projections.next();
assertTrue( projections.isFirst() );
tx.commit();
fullTextSession.close();
}
@Test
public void testFetchSizeLargerThanHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:ITech" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setProjection( "id", "lastname", "dept" );
hibQuery.setFetchSize( 6 );
ScrollableResults results = hibQuery.scroll();
results.beforeFirst();
results.next();
Object[] result = results.get();
assertEquals( "incorrect entityInfo returned", 1000, result[0] );
tx.commit();
fullTextSession.close();
}
@Test
public void testFetchSizeDefaultFirstAndMax() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:ITech" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setSort( new Sort( new SortField( "id", SortField.Type.STRING ) ) );
hibQuery.setProjection( "id", "lastname", "dept" );
hibQuery.setFetchSize( 3 );
ScrollableResults results = hibQuery.scroll();
results.beforeFirst();
results.next();
Object[] result = results.get();
assertEquals( "incorrect entityInfo returned", 1000, result[0] );
results.scroll( 2 );
result = results.get();
assertEquals( "incorrect entityInfo returned", 1003, result[0] );
// check cache addition
results.next();
result = results.get();
assertEquals( "incorrect entityInfo returned", 1004, result[0] );
results.scroll( -2 );
result = results.get();
assertEquals( "incorrect entityInfo returned", 1002, result[0] );
tx.commit();
fullTextSession.close();
}
@Test
public void testFetchSizeNonDefaultFirstAndMax() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:ITech" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setProjection( "id", "lastname", "dept" );
hibQuery.setFetchSize( 3 );
hibQuery.setFirstResult( 1 );
hibQuery.setMaxResults( 3 );
hibQuery.setSort( new Sort( new SortField( "id", SortField.Type.STRING ) ) );
ScrollableResults results = hibQuery.scroll();
results.beforeFirst();
results.next();
Object[] result = results.get();
assertEquals( "incorrect entityInfo returned", 1002, result[0] );
results.scroll( 2 );
result = results.get();
assertEquals( "incorrect entityInfo returned", 1004, result[0] );
results.next();
result = results.get();
assertNull( result );
results.scroll( -8 );
result = results.get();
assertNull( result );
// And test a bad forward scroll.
results.scroll( 10 );
result = results.get();
assertNull( result );
tx.commit();
fullTextSession.close();
}
@Test
public void testFetchSizeNonDefaultFirstAndMaxNoHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:XXX" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setProjection( "id", "lastname", "dept" );
hibQuery.setFetchSize( 3 );
hibQuery.setFirstResult( 1 );
hibQuery.setMaxResults( 3 );
ScrollableResults results = hibQuery.scroll();
results.beforeFirst();
Object[] result = results.get();
assertNull( "non-null entity infos returned", result );
tx.commit();
fullTextSession.close();
}
/**
* Test for HSEARCH-604. Tests that max result 0 does not throw an exception.
*
* @throws Exception in case the test fails.
*/
@Test
public void testMaxResultZero() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:foo" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setFirstResult( 0 );
hibQuery.setMaxResults( 0 );
List result = hibQuery.list();
assertTrue( "We should get the empty result list", result.isEmpty() );
hibQuery.setFirstResult( 1 );
hibQuery.setMaxResults( 0 );
result = hibQuery.list();
assertTrue( "We should get the empty result list", result.isEmpty() );
tx.commit();
fullTextSession.close();
}
@Test
public void testCurrent() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:ITech" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
hibQuery.setProjection( "id", "lastname", "dept" );
ScrollableResults results = hibQuery.scroll();
results.beforeFirst();
results.next();
assertTrue( "beforeFirst() pointer incorrect", results.isFirst() );
results.afterLast();
results.previous();
assertTrue( "afterLast() pointer incorrect", results.isLast() );
// Let's see if a bad reverse scroll screws things up
results.scroll( -8 );
results.next();
assertTrue( "large negative scroll() pointer incorrect", results.isFirst() );
// And test a bad forward scroll.
results.scroll( 10 );
results.previous();
assertTrue( "large positive scroll() pointer incorrect", results.isLast() );
// Finally, let's test a REAL screwup.
hibQuery.setFirstResult( 3 );
hibQuery.setMaxResults( 1 );
results = hibQuery.scroll();
results.first();
Object[] result = results.get();
assertEquals( 1004, result[0] );
results.last();
result = results.get();
assertEquals( 1004, result[0] );
tx.commit();
fullTextSession.close();
}
@Test
public void testMultipleEntityPerIndex() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
AlternateBook alternateBook = new AlternateBook(
1, "La chute de la petite reine a travers les yeux de Festina"
);
fullTextSession.save( alternateBook );
tx.commit();
fullTextSession.clear();
tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with explicit class filter", 1, result.size() );
query = parser.parse( "summary:Festina" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
Iterator it = hibQuery.iterate();
assertTrue( it.hasNext() );
assertNotNull( it.next() );
assertFalse( it.hasNext() );
query = parser.parse( "summary:Festina" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
ScrollableResults sr = hibQuery.scroll();
assertTrue( sr.first() );
assertNotNull( sr.get() );
assertFalse( sr.next() );
sr.close();
query = parser.parse( "summary:Festina OR brand:seiko" );
hibQuery = fullTextSession.createFullTextQuery( query, Clock.class, Book.class );
hibQuery.setMaxResults( 2 );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with explicit class filter and limit", 2, result.size() );
query = parser.parse( "summary:Festina" );
hibQuery = fullTextSession.createFullTextQuery( query );
result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with no class filter", 2, result.size() );
for ( Object element : result ) {
assertTrue( HibernateHelper.isInitialized( element ) );
}
tx.commit();
fullTextSession.close();
}
@Test
public void testCriteria() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "title", TestConstants.stopAnalyzer );
Query query = parser.parse( "summary:Festina" );
org.hibernate.Query hibQuery = fullTextSession.createFullTextQuery( query, Book.class );
List result = hibQuery.list();
assertNotNull( result );
assertEquals( "Query with no explicit criteria", 1, result.size() );
Book book = (Book) result.get( 0 );
assertFalse( "Association should not be initialized", HibernateHelper.isInitialized( book.getAuthors() ) );
result = fullTextSession.createFullTextQuery( query ).setCriteriaQuery(
fullTextSession.createCriteria( Book.class ).setFetchMode( "authors", FetchMode.JOIN )
).list();
assertNotNull( result );
assertEquals( "Query with explicit criteria", 1, result.size() );
book = (Book) result.get( 0 );
assertTrue( "Association should be initialized", HibernateHelper.isInitialized( book.getAuthors() ) );
assertEquals( 1, book.getAuthors().size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testScrollEmptyHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:XXX" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
ScrollableResults projections = hibQuery.scroll();
projections.beforeFirst();
projections.next();
Object[] projection = projections.get();
assertNull( projection );
hibQuery = fullTextSession.createFullTextQuery( query, Employee.class ).setFirstResult( 10 ).setMaxResults( 20 );
projections = hibQuery.scroll();
projections.beforeFirst();
projections.next();
projection = projections.get();
assertNull( projection );
tx.commit();
fullTextSession.close();
}
@Test
public void testListEmptyHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:XXX" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
List result = hibQuery.list();
assertEquals( 0, result.size() );
hibQuery = fullTextSession.createFullTextQuery( query, Employee.class ).setFirstResult( 10 ).setMaxResults( 20 );
result = hibQuery.list();
assertEquals( 0, result.size() );
tx.commit();
fullTextSession.close();
}
@Test
public void testIterateEmptyHits() throws Exception {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
QueryParser parser = new QueryParser( TestConstants.getTargetLuceneVersion(), "dept", TestConstants.standardAnalyzer );
Query query = parser.parse( "dept:XXX" );
org.hibernate.search.FullTextQuery hibQuery = fullTextSession.createFullTextQuery( query, Employee.class );
Iterator iter = hibQuery.iterate();
assertFalse( iter.hasNext() );
hibQuery = fullTextSession.createFullTextQuery( query, Employee.class ).setFirstResult( 10 ).setMaxResults( 20 );
iter = hibQuery.iterate();
assertFalse( iter.hasNext() );
tx.commit();
fullTextSession.close();
}
private void indexTestData() {
FullTextSession fullTextSession = Search.getFullTextSession( openSession() );
Transaction tx = fullTextSession.beginTransaction();
Clock clock = new Clock( 1, "Seiko" );
fullTextSession.save( clock );
clock = new Clock( 2, "Festina" );
fullTextSession.save( clock );
Book book = new Book(
1,
"La chute de la petite reine a travers les yeux de Festina",
"La chute de la petite reine a travers les yeux de Festina, blahblah"
);
fullTextSession.save( book );
Author emmanuel = new Author();
emmanuel.setName( "Emmanuel" );
fullTextSession.save( emmanuel );
book.getAuthors().add( emmanuel );
book = new Book( 2, "La gloire de mon père", "Les deboires de mon père en vélo" );
fullTextSession.save( book );
fullTextSession.save( new Employee( 1000, "Griffin", "ITech" ) );
fullTextSession.save( new Employee( 1001, "Jackson", "Accounting" ) );
fullTextSession.save( new Employee( 1002, "Jimenez", "ITech" ) );
fullTextSession.save( new Employee( 1003, "Stejskal", "ITech" ) );
fullTextSession.save( new Employee( 1004, "Whetbrook", "ITech" ) );
tx.commit();
fullTextSession.close();
}
@Override
protected Class<?>[] getAnnotatedClasses() {
return new Class[] {
Book.class,
AlternateBook.class,
Clock.class,
Author.class,
Employee.class
};
}
}