Spring/spring-data-examples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#28 - Added example for Spring Data Elasticsearch.

Browse Source 
Added basic example to show repository and ElasticsearchOperations usage.
This commit is contained in:
Artur Konczak
2014-10-31 00:20:18 +00:00
committed by Oliver Gierke
parent 7f3339a610
commit f9aa1556d8
11 changed files with 358 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -32,6 +32,10 @@ We have separate folders for the samples of individual modules:
* `example` - Example for basic Sprign Data Redis setup.
* `cluster-sentinel` - Example for Redis cluster and Sentinel support.
## Spring Data Elasticsearch
* `example` - Example how to use basic text search, geo-spatial search and facets.
## Miscellaneous
* `multi-store` - Example project to use both Spring Data MongoDB and Spring Data JPA in one project.

13
elasticsearch/example/.gitignore vendored Normal file
View File

@@ -0,0 +1,13 @@
.project
.classpath
.springBeans
.settings/
target/
#IntelliJ Stuff
.idea
*.iml
##ignore local node data files for unit tests
/data
/.DS_Store

14
elasticsearch/example/README.md Normal file
View File

@@ -0,0 +1,14 @@
# Spring Data Elasticsearch - Examples
Requirements:
* [Maven](http://maven.apache.org/download.cgi) - required.
* [Elasticsearch](http://www.elasticsearch.org/overview/elkdownloads) - optional.
To use local elasticsearch cluster:
* install elasticsearch
* uncomment both properties in file 'application.properties'

19
elasticsearch/example/pom.xml Normal file
View File

@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>spring-data-elasticsearch-example</artifactId>
<name>Spring Data Elasticsearch - Example</name>
<description>Sample projects for Spring Data Elasticsearch</description>
<url>https://github.com/spring-projects/spring-data-elasticsearch</url>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-elasticsearch-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
</project>

63
elasticsearch/example/src/main/java/example/springdata/elasticsearch/ApplicationConfiguration.java Normal file
View File

@@ -0,0 +1,63 @@
/*
* Copyright 2014-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch;
import java.util.Arrays;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
/**
* @author Artur Konczak
* @author Oliver Gierke
*/
@Configuration
@EnableAutoConfiguration
class ApplicationConfiguration {
@Autowired ElasticsearchOperations operations;
@Autowired ConferenceRepository repository;
@PreDestroy
public void deleteIndex() {
operations.deleteIndex(Conference.class);
}
@PostConstruct
public void insertDataSample() {
// Remove all documents
repository.deleteAll();
operations.refresh(Conference.class, true);
// Save data sample
repository.save(Conference.builder().date("2014-11-06").name("Spring eXchange 2014 - London")
.keywords(Arrays.asList("java", "spring")).location("51.500152, -0.126236").build());
repository.save(Conference.builder().date("2014-12-07").name("Scala eXchange 2014 - London")
.keywords(Arrays.asList("scala", "play", "java")).location("51.500152, -0.126236").build());
repository.save(Conference.builder().date("2014-11-20").name("Elasticsearch 2014 - Berlin")
.keywords(Arrays.asList("java", "elasticsearch", "kibana")).location("52.5234051, 13.4113999").build());
repository.save(Conference.builder().date("2014-11-12").name("AWS London 2014")
.keywords(Arrays.asList("cloud", "aws")).location("51.500152, -0.126236").build());
repository.save(Conference.builder().date("2014-10-04").name("JDD14 - Cracow")
.keywords(Arrays.asList("java", "spring")).location("50.0646501, 19.9449799").build());
}
}

57
elasticsearch/example/src/main/java/example/springdata/elasticsearch/Conference.java Normal file
View File

@@ -0,0 +1,57 @@
/*
* Copyright 2014-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch;
import static org.springframework.data.elasticsearch.annotations.FieldType.*;
import java.util.List;
import lombok.Data;
import lombok.experimental.Builder;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.GeoPointField;
/**
* @author Artur Konczak
* @author Oliver Gierke
*/
@Data
@Builder
@Document(indexName = "conference-index", shards = 1, replicas = 0, indexStoreType = "memory", refreshInterval = "-1")
public class Conference {
private @Id String id;
private String name;
private @Field(type = Date) String date;
private @GeoPointField String location;
private List<String> keywords;
// do not remove it
public Conference() {}
// do not remove it - work around for lombok generated constructor for all params
public Conference(String id, String name, String date, String location, List<String> keywords) {
this.id = id;
this.name = name;
this.date = date;
this.location = location;
this.keywords = keywords;
}
}

24
elasticsearch/example/src/main/java/example/springdata/elasticsearch/ConferenceRepository.java Normal file
View File

@@ -0,0 +1,24 @@
/*
* Copyright 2014-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch;
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
/**
* @author Artur Konczak
* @author Oliver Gierke
*/
interface ConferenceRepository extends ElasticsearchRepository<Conference, String> {}

3
elasticsearch/example/src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,3 @@
# Uncomment both entries to connect with local elasticsearch cluster
#spring.data.elasticsearch.clusterName=elasticsearch
#spring.data.elasticsearch.clusterNodes=localhost:9300

131
elasticsearch/example/src/test/java/example/springdata/elasticsearch/ElasticsearchOperationsTest.java Normal file
View File

@@ -0,0 +1,131 @@
/*
* Copyright 2014-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package example.springdata.elasticsearch;
import static org.elasticsearch.index.query.QueryBuilders.*;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
import org.springframework.data.elasticsearch.core.FacetedPage;
import org.springframework.data.elasticsearch.core.facet.request.HistogramFacetRequestBuilder;
import org.springframework.data.elasticsearch.core.facet.request.TermFacetRequestBuilder;
import org.springframework.data.elasticsearch.core.facet.result.HistogramResult;
import org.springframework.data.elasticsearch.core.facet.result.TermResult;
import org.springframework.data.elasticsearch.core.query.Criteria;
import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* Test case to show Spring Data Elasticsearch functionality.
*
* @author Artur Konczak
* @author Oliver Gierke
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = ApplicationConfiguration.class)
public class ElasticsearchOperationsTest {
private static final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
@Autowired ElasticsearchOperations operations;
@Test
public void textSearch() throws ParseException {
String expectedDate = "2014-10-29";
String expectedWord = "java";
CriteriaQuery query = new CriteriaQuery(new Criteria("_all").contains(expectedWord).and(
new Criteria("date").greaterThanEqual(expectedDate)));
List<Conference> result = operations.queryForList(query, Conference.class);
assertThat(result, hasSize(3));
for (Conference conference : result) {
assertThat(conference.getKeywords(), hasItem(expectedWord));
assertThat(format.parse(conference.getDate()), greaterThan(format.parse(expectedDate)));
}
}
@Test
public void geoSpatialSearch() {
String startLocation = "50.0646501,19.9449799";
String range = "330mi"; // or 530km
CriteriaQuery query = new CriteriaQuery(new Criteria("location").within(startLocation, range));
List<Conference> result = operations.queryForList(query, Conference.class);
assertThat(result, hasSize(2));
}
@Test
public void termFacet() {
String termField = "keywords";
String facetName = "all-keywords";
FacetedPage<Conference> firstPage = operations.queryForPage(//
new NativeSearchQueryBuilder().//
withQuery(matchAllQuery()).//
withFacet(new TermFacetRequestBuilder(facetName).//
allTerms().//
descCount().//
fields(termField).build()).//
build(), Conference.class);
TermResult facet = (TermResult) firstPage.getFacet(facetName);
assertThat(facet.getTerms(), hasSize(8));
facet.getTerms().forEach(
term -> {
assertThat(term.getTerm(),
isOneOf("java", "spring", "scala", "play", "elasticsearch", "kibana", "cloud", "aws"));
});
}
@Test
public void histogramFacetOnDate() {
String termField = "date";
int interval = 30;
String facetName = "by-date";
FacetedPage<Conference> firstPage = operations.queryForPage(new NativeSearchQueryBuilder() //
.withQuery(matchAllQuery()) //
.withFacet(new HistogramFacetRequestBuilder(facetName).//
timeUnit(TimeUnit.DAYS).//
interval(interval). //
field(termField).build()).//
build(), Conference.class);
HistogramResult facet = (HistogramResult) firstPage.getFacet(facetName);
assertThat(facet.getIntervalUnit(), hasSize(3));
}
}

29
elasticsearch/pom.xml Normal file
View File

@@ -0,0 +1,29 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-data-elasticsearch-examples</artifactId>
<packaging>pom</packaging>
<parent>
<groupId>org.springframework.data.examples</groupId>
<artifactId>spring-data-examples</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
</parent>
<name>Spring Data Elasticsearch - Examples</name>
<description>Sample projects for Spring Data Elasticsearch</description>
<url>https://github.com/spring-projects/spring-data-elasticsearch</url>
<modules>
<module>example</module>
</modules>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>
</dependencies>
</project>

1
pom.xml
View File

@@ -24,6 +24,7 @@
<module>redis</module>
<module>solr</module>
<module>cassandra</module>
<module>elasticsearch</module>
</modules>
<properties>