Java tutorial
/* * 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.backend.elasticsearch; import java.math.BigInteger; import java.util.Arrays; import java.util.Calendar; import java.util.List; import java.util.Locale; import java.util.TimeZone; import org.apache.lucene.search.Sort; import org.apache.lucene.search.SortField; import org.hibernate.ScrollableResults; import org.hibernate.Session; import org.hibernate.Transaction; import org.hibernate.search.FullTextQuery; import org.hibernate.search.FullTextSession; import org.hibernate.search.Search; import org.hibernate.search.backend.elasticsearch.ElasticSearchQueries; import org.hibernate.search.backend.elasticsearch.ProjectionConstants; import org.hibernate.search.query.engine.spi.QueryDescriptor; import org.hibernate.search.test.SearchTestBase; import org.hibernate.search.test.embedded.Address; import org.hibernate.search.test.embedded.Country; import org.hibernate.search.test.embedded.Owner; import org.hibernate.search.test.embedded.Person; import org.hibernate.search.test.embedded.State; import org.hibernate.search.test.embedded.StateCandidate; import org.hibernate.search.test.embedded.Tower; import org.hibernate.search.testutil.backend.elasticsearch.JsonHelper; import org.junit.After; import org.junit.Before; import org.junit.Test; import static org.fest.assertions.Assertions.assertThat; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; /** * @author Gunnar Morling */ public class ElasticSearchIT extends SearchTestBase { @Before public void setupTestData() { Session s = openSession(); Transaction tx = s.beginTransaction(); ScientificArticle article1 = new ScientificArticle("ORM for dummies", "Object/relational mapping with Hibernate", "blah blah blah", 7); s.persist(article1); ScientificArticle article2 = new ScientificArticle("Latest in ORM", "Object/relational mapping with Hibernate - The latest news", "blah blah blah", 8); s.persist(article2); ScientificArticle article3 = new ScientificArticle("ORM for beginners", "Object/relational mapping with an unknown tool", "blah blah blah", 9); s.persist(article3); ScientificArticle article4 = new ScientificArticle("High-performance ORM", "Tuning persistence with Hibernate", "blah blah blah", 10); s.persist(article4); ScientificArticle article5 = new ScientificArticle("ORM modelling", "Modelling your domain model with Hibernate", "blah blah blah", 11); s.persist(article5); ResearchPaper paper1 = new ResearchPaper("Very important research on Hibernate", "Latest research on Hibernate", "blah blah blah", 7); s.persist(paper1); ResearchPaper paper2 = new ResearchPaper("Some research", "Important Hibernate research", "blah blah blah", 7); s.persist(paper2); BachelorThesis bachelorThesis = new BachelorThesis("Latest findings", "blah blah blah"); s.persist(bachelorThesis); MasterThesis masterThesis = new MasterThesis("Great findings", "blah blah blah"); s.persist(masterThesis); Calendar dob = Calendar.getInstance(TimeZone.getTimeZone("UTC"), Locale.ENGLISH); dob.set(1958, 3, 7, 0, 0, 0); dob.set(Calendar.MILLISECOND, 0); GolfPlayer hergesheimer = new GolfPlayer.Builder().firstName("Klaus").lastName("Hergesheimer").active(true) .dateOfBirth(dob.getTime()).handicap(3.4).puttingStrength(2.5).driveWidth(285).ranking(311).build(); s.persist(hergesheimer); tx.commit(); s.close(); } @After public void deleteTestData() { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries.fromJson("{ 'query': { 'match_all' : {} } }"); List<?> result = session.createFullTextQuery(query).list(); for (Object entity : result) { session.delete(entity); } tx.commit(); s.close(); } @Test public void testFields() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); List<?> result = session.createFullTextQuery(query, ScientificArticle.class).list(); assertThat(result).onProperty("title").containsOnly("Latest in ORM", "ORM for dummies", "High-performance ORM", "ORM modelling"); tx.commit(); s.close(); } @Test public void testNumericFieldQuery() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'range' : { 'wordCount' : { 'gte' : 8, 'lt' : 10 } } } }"); List<?> result = session.createFullTextQuery(query).list(); assertThat(result).onProperty("title").containsOnly("Latest in ORM", "ORM for beginners"); tx.commit(); s.close(); } @Test public void testEmbeddedIndexing() throws Exception { Tower tower = new Tower(); tower.setName("JBoss tower"); Address a = new Address(); a.setStreet("Tower place"); a.getTowers().add(tower); tower.setAddress(a); Person o = new Owner(); o.setName("Atlanta Renting corp"); a.setOwnedBy(o); o.setAddress(a); Country c = new Country(); c.setName("France"); a.setCountry(c); Session s = openSession(); Transaction tx = s.beginTransaction(); s.persist(tower); tx.commit(); FullTextSession session = Search.getFullTextSession(s); QueryDescriptor query; List<?> result; query = ElasticSearchQueries .fromJson("{" + "'query' : { " + "'nested' : { " + "'path' : 'address'," + " 'query': { " + "'match' : { " + "'address.street' : 'place'" + " }" + " }" + " }" + " }" + " }"); result = session.createFullTextQuery(query, Tower.class).list(); assertEquals("unable to find property in embedded", 1, result.size()); query = ElasticSearchQueries .fromJson("{" + "'query' : { " + "'nested' : { " + "'path' : 'address'," + " 'query': { " + "'match' : { " + "'address.ownedBy_name' : 'renting'" + " }" + " }" + " }" + " }" + " }"); result = session.createFullTextQuery(query, Tower.class).list(); assertEquals("unable to find property in embedded", 1, result.size()); query = ElasticSearchQueries .fromJson("{" + "'query' : { " + "'nested' : { " + "'path' : 'address'," + " 'query': { " + "'match' : { " + "'address.id' : " + a.getId() + " }" + " }" + " }" + " }" + " }"); result = session.createFullTextQuery(query, Tower.class).list(); assertEquals("unable to find property by id of embedded", 1, result.size()); query = ElasticSearchQueries .fromJson("{" + "'query' : { " + "'nested' : { " + "'path' : 'address.country'," + " 'query': { " + "'match' : { " + "'address.country.name' : 'France'" + " }" + " }" + " }" + " }" + " }"); result = session.createFullTextQuery(query, Tower.class).list(); assertEquals("unable to find property with 2 levels of embedded", 1, result.size()); s.clear(); tx = s.beginTransaction(); Address address = s.get(Address.class, a.getId()); address.getOwnedBy().setName("Buckhead community"); tx.commit(); s.clear(); session = Search.getFullTextSession(s); query = ElasticSearchQueries.fromJson( "{" + "'query' : { " + "'nested' : { " + "'path' : 'address'," + " 'query': { " + "'match' : { " + "'address.ownedBy_name' : 'buckhead'" + " }" + " }" + " }" + " }" + " }"); result = session.createFullTextQuery(query, Tower.class).list(); assertEquals("change in embedded not reflected in root index", 1, result.size()); s.clear(); tx = s.beginTransaction(); s.delete(s.get(Tower.class, tower.getId())); tx.commit(); s.close(); } @Test public void testIndexSharing() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'title' : 'findings' } } }"); List<?> result = session.createFullTextQuery(query, MasterThesis.class, BachelorThesis.class).list(); assertThat(result).onProperty("title").containsOnly("Great findings", "Latest findings"); tx.commit(); s.close(); } @Test public void testRestrictionByType() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); List<?> result = session.createFullTextQuery(query, ResearchPaper.class).list(); assertThat(result).onProperty("title").containsOnly("Very important research on Hibernate", "Some research"); tx.commit(); s.close(); } @Test public void testMapping() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries.fromJson("{ 'query': { 'match' : { 'active' : true } } }"); List<?> result = session.createFullTextQuery(query, GolfPlayer.class) .setProjection(ProjectionConstants.SOURCE).list(); String source = (String) ((Object[]) result.iterator().next())[0]; JsonHelper.assertJsonEquals("{" + "\"active\": true," + "\"dateOfBirth\": \"1958-04-07T00:00:00Z\"," + "\"driveWidth\": 285," + "\"firstName\": \"Klaus\"," + "\"handicap\": 3.4," + "\"lastName\": \"Hergesheimer\"," + "\"ranking\": {" + "\"value\": \"311\"" + "}," + "\"fullName\": \"Klaus Hergesheimer\"," + "\"age\": 34," + "\"puttingStrength\": \"2.5\"" + "}", source); tx.commit(); s.close(); } @Test public void testFirstResultAndMaxResults() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); List<?> result = session.createFullTextQuery(query, ScientificArticle.class).setFirstResult(1) .setMaxResults(2).list(); // Order is stable due to the result scoring assertThat(result).onProperty("title").containsOnly("ORM modelling", "ORM for dummies"); tx.commit(); s.close(); } @Test public void testGetResultSize() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); FullTextQuery fullTextQuery = session.createFullTextQuery(query, ScientificArticle.class); assertThat(fullTextQuery.getResultSize()).isEqualTo(4); tx.commit(); s.close(); } @Test public void testScroll() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); FullTextQuery fullTextQuery = session.createFullTextQuery(query, ScientificArticle.class); ScrollableResults scrollableResults = fullTextQuery.scroll(); assertEquals(-1, scrollableResults.getRowNumber()); assertTrue(scrollableResults.last()); assertEquals(3, scrollableResults.getRowNumber()); scrollableResults.beforeFirst(); List<String> expectedTitles = Arrays.asList("High-performance ORM", "ORM for dummies", "ORM modelling", "Latest in ORM"); int position = 0; while (scrollableResults.next()) { ScientificArticle article = (ScientificArticle) scrollableResults.get()[0]; assertThat(article.getTitle()).isEqualTo(expectedTitles.get(position)); position++; } scrollableResults.close(); fullTextQuery = session.createFullTextQuery(query, ScientificArticle.class); scrollableResults = fullTextQuery.setFirstResult(1).setMaxResults(2).scroll(); assertEquals(-1, scrollableResults.getRowNumber()); assertTrue(scrollableResults.last()); assertEquals(1, scrollableResults.getRowNumber()); scrollableResults.beforeFirst(); expectedTitles = Arrays.asList("ORM for dummies", "ORM modelling"); position = 0; while (scrollableResults.next()) { ScientificArticle article = (ScientificArticle) scrollableResults.get()[0]; assertThat(article.getTitle()).isEqualTo(expectedTitles.get(position)); position++; } scrollableResults.close(); tx.commit(); s.close(); } @Test public void testSort() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'abstract' : 'Hibernate' } } }"); // by title, ascending List<?> result = session.createFullTextQuery(query, ScientificArticle.class) .setSort(new Sort(new SortField("title", SortField.Type.STRING, false))).list(); assertThat(result).onProperty("title").containsExactly("High-performance ORM", "Latest in ORM", "ORM for dummies", "ORM modelling"); // By id, descending result = session.createFullTextQuery(query, ScientificArticle.class) .setSort(new Sort(new SortField("_uid", SortField.Type.STRING, true))).list(); assertThat(result).onProperty("id").containsExactly(5L, 4L, 2L, 1L); tx.commit(); s.close(); } @Test public void testFieldBoost() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries.fromJson( "{" + "'query': {" + "'bool' : {" + "'should' : [" + "{ 'match' : { 'abstract' : 'important' } }," + "{ 'match' : { 'title' : 'important' } }" + "]" + "}" + "}" + "}"); List<?> result = session.createFullTextQuery(query, ResearchPaper.class).list(); assertThat(result).onProperty("title").containsExactly("Very important research on Hibernate", "Some research"); tx.commit(); s.close(); } @Test public void testQueryStringQuery() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries.fromQueryString("abstract:Hibernate"); List<?> result = session.createFullTextQuery(query, ScientificArticle.class).list(); assertThat(result).onProperty("title").containsOnly("Latest in ORM", "ORM for dummies", "High-performance ORM", "ORM modelling"); query = ElasticSearchQueries.fromQueryString("abstract:important OR title:important"); result = session.createFullTextQuery(query, ResearchPaper.class).list(); assertThat(result).onProperty("title").containsExactly("Very important research on Hibernate", "Some research"); query = ElasticSearchQueries.fromQueryString("wordCount:[8 TO 10}"); result = session.createFullTextQuery(query, ScientificArticle.class).list(); assertThat(result).onProperty("title").containsOnly("Latest in ORM", "ORM for beginners"); tx.commit(); s.close(); } @Test public void testProjection() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries.fromQueryString("lastName:Hergesheimer"); List<?> result = session.createFullTextQuery(query, GolfPlayer.class) .setProjection(ProjectionConstants.ID, ProjectionConstants.OBJECT_CLASS, ProjectionConstants.SCORE, ProjectionConstants.THIS, "firstName", "lastName", "active", "dateOfBirth", "handicap", "driveWidth", "ranking.value") .list(); assertThat(result).hasSize(1); Calendar dob = Calendar.getInstance(TimeZone.getTimeZone("UTC"), Locale.ENGLISH); dob.set(1958, 3, 7, 0, 0, 0); dob.set(Calendar.MILLISECOND, 0); Object[] projection = (Object[]) result.iterator().next(); assertThat(projection[0]).describedAs("id").isEqualTo(1L); assertThat(projection[1]).describedAs("object class").isEqualTo(GolfPlayer.class); assertThat(projection[2]).describedAs("score").isEqualTo(1.0F); assertThat(projection[3]).describedAs("this").isInstanceOf(GolfPlayer.class); assertThat(((GolfPlayer) projection[3]).getId()).isEqualTo(1L); assertThat(projection[4]).describedAs("firstName").isEqualTo("Klaus"); assertThat(projection[5]).describedAs("lastName").isEqualTo("Hergesheimer"); assertThat(projection[6]).describedAs("active").isEqualTo(true); assertThat(projection[7]).describedAs("dateOfBirth").isEqualTo(dob.getTime()); assertThat(projection[8]).describedAs("handicap").isEqualTo(3.4D); assertThat(projection[9]).describedAs("driveWidth").isEqualTo(285); assertThat(projection[10]).describedAs("ranking value").isEqualTo(BigInteger.valueOf(311)); tx.commit(); s.close(); } @Test public void testQueryById() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{" + "'query': {" + "'ids' : {" + "'values' : ['1', '3']" + "}" + "}" + "}"); List<?> result = session.createFullTextQuery(query, ScientificArticle.class).list(); assertThat(result).onProperty("title").containsOnly("ORM for dummies", "ORM for beginners"); query = ElasticSearchQueries.fromQueryString("_id:1 OR _id:3"); result = session.createFullTextQuery(query, ScientificArticle.class).list(); assertThat(result).onProperty("title").containsOnly("ORM for dummies", "ORM for beginners"); tx.commit(); s.close(); } @Test public void testStringMappedNumericProperty() throws Exception { Session s = openSession(); FullTextSession session = Search.getFullTextSession(s); Transaction tx = s.beginTransaction(); QueryDescriptor query = ElasticSearchQueries .fromJson("{ 'query': { 'match' : { 'puttingStrength' : '2.5' } } }"); List<?> result = session.createFullTextQuery(query, GolfPlayer.class) .setProjection(ProjectionConstants.ID, "puttingStrength").list(); assertThat(result).hasSize(1); Object[] projection = (Object[]) result.iterator().next(); assertThat(projection[0]).isEqualTo(1L); assertThat(projection[1]).isEqualTo(2.5D); tx.commit(); s.close(); } @Override public Class<?>[] getAnnotatedClasses() { return new Class[] { ScientificArticle.class, Tower.class, Address.class, Country.class, State.class, StateCandidate.class, ResearchPaper.class, BachelorThesis.class, MasterThesis.class, GolfPlayer.class }; } }