spring-data-solr-showcase

.gitignore

@@ -0,0 +1,10 @@
+target/
+.settings/
+.project
+.classpath
+.springBeans
+.sonar4clipse
+*.sonar4clipseExternals
+.idea
+spring-data-solr.iml
+.DS_Store

README.md

@@ -1,2 +1,34 @@
-spring-data-solr-showcase
+Spring Data Solr Showcase
 =========================
+
+This example shows basic usage concepts of [Spring Data Solr](http://projects.spring.io/spring-data-solr).
+
+The commit order from initial to latest guides you through:
+
+1. STEP 1: Initial setup and configuration.
+2. STEP 2: Custom `Repository` implementation for autocomplete.
+3. STEP 3: `@Facet` annotation as alternative to custom implementation.
+4. STEP 4: Highlighting of search terms in result.
+5. STEP 5: Type mapping for custom types.
+6. STEP 6: Use multicore support to enable automatic template configuration.
+
+In order to run this example a 4+ [Solr Server](http://lucene.apache.org/solr/downloads.html) and [Maven](http://maven.apache.org/download.cgi) are required.
+
+The application is meant to work with the example data provided by the Solr distribution.
+
+### Running Solr
+```emacs
+:solr> cd example
+:example> java -jar start.jar
+:example> cd exampledocs
+:exampledocs> java -jar post.jar *.xml
+```
+
+Access via [localhost:8983/solr/](http://localhost:8983/solr/#/collection1)
+
+### Running Showcase
+```emacs
+:spring-data-solr-showcase> mvn spring-boot:run
+```
+
+Access via [localhost:8080/search](http://localhost:8080/search)

pom.xml

@@ -0,0 +1,129 @@
+<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.data</groupId>
+	<artifactId>spring-data-solr-showcase</artifactId>
+	<version>1.0.0.BUILD-SNAPSHOT</version>
+	<packaging>war</packaging>
+	<inceptionYear>2013</inceptionYear>
+	<url>https://github.com/christophstrobl/spring-data-solr-showcase</url>
+	<name>Spring Data Solr Showcase</name>
+	<description>Spring Data Solr - Spring MVC Application Showcase</description>
+
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>1.0.1.RELEASE</version>
+	</parent>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+		</dependency>
+
+		<!-- SOLR -->
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-solr</artifactId>
+			<version>${spring-data-solr.verion}</version>
+		</dependency>
+
+		<!-- JSON -->
+		<dependency>
+			<groupId>org.codehaus.jackson</groupId>
+			<artifactId>jackson-mapper-asl</artifactId>
+			<version>1.9.11</version>
+		</dependency>
+
+		<!-- WEB -->
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>jstl</artifactId>
+		</dependency>
+		<dependency>
+		    <groupId>org.apache.tomcat.embed</groupId>
+		    <artifactId>tomcat-embed-jasper</artifactId>
+		    <scope>provided</scope>
+		</dependency>
+	</dependencies>
+
+	<properties>
+		<start-class>org.springframework.data.solr.showcase.Application</start-class>
+		<java.version>1.7</java.version>
+
+		<!--  -->
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<junit.version>4.10</junit.version>
+		<spring-data-solr.verion>1.1.0.RELEASE</spring-data-solr.verion>
+		<org.springframework.version>4.0.2.RELEASE</org.springframework.version>
+		<springhateoas>0.9.0.RELEASE</springhateoas>
+		<servlet-api.version>3.0.1</servlet-api.version>
+	</properties>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+
+	<licenses>
+		<license>
+			<name>The Apache Software License, Version 2.0</name>
+			<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+			<distribution>repo</distribution>
+			<comments>
+        Copyright 2010 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.
+      </comments>
+		</license>
+	</licenses>
+
+	<scm>
+		<url>https://github.com/christophstrobl/spring-data-solr-showcase</url>
+		<connection>scm:git:git://github.com/christophstrobl/spring-data-solr-showcase.git</connection>
+		<developerConnection>scm:git:ssh://git@github.com:christophstrobl/spring-data-solr-showcase.git</developerConnection>
+	</scm>
+
+
+	<developers>
+		<developer>
+			<id>christophstrobl</id>
+			<name>Christoph Strobl</name>
+			<timezone>+1</timezone>
+		</developer>
+	</developers>
+
+	<repositories>
+		<repository>
+			<id>spring-snapshots</id>
+			<url>http://repo.springsource.org/libs-snapshot</url>
+		</repository>
+		<repository>
+			<id>spring-releases</id>
+			<url>http://repo.springsource.org/libs-release</url>
+		</repository>
+	</repositories>
+
+</project>  

src/main/java/org/springframework/data/solr/showcase/Application.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2014 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 org.springframework.data.solr.showcase;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.solr.showcase.config.SearchContext;
+import org.springframework.data.solr.showcase.config.WebContext;
+
+/**
+ * @author Christoph Strobl
+ */
+@Configuration
+@ComponentScan
+@EnableAutoConfiguration
+@Import({ WebContext.class, SearchContext.class })
+public class Application {
+
+	public static void main(String[] args) {
+		SpringApplication.run(Application.class, args);
+	}
+
+}

src/main/java/org/springframework/data/solr/showcase/config/SearchContext.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2012 - 2014 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 org.springframework.data.solr.showcase.config;
+
+import org.apache.solr.client.solrj.SolrServer;
+import org.apache.solr.client.solrj.impl.HttpSolrServer;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.solr.repository.config.EnableSolrRepositories;
+
+/**
+ * @author Christoph Strobl
+ */
+@Configuration
+@EnableSolrRepositories(basePackages = { "org.springframework.data.solr.showcase.product" }, multicoreSupport = true)
+public class SearchContext {
+
+	@Bean
+	public SolrServer solrServer(@Value("${solr.host}") String solrHost) {
+		return new HttpSolrServer(solrHost);
+	}
+
+}

src/main/java/org/springframework/data/solr/showcase/config/WebContext.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014 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 org.springframework.data.solr.showcase.config;
+
+import java.util.List;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
+import org.springframework.web.method.support.HandlerMethodArgumentResolver;
+import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
+
+/**
+ * @author Christoph Strobl
+ */
+@Configuration
+public class WebContext {
+
+	@Bean
+	public WebMvcConfigurerAdapter mvcViewConfigurer() {
+
+		return new WebMvcConfigurerAdapter() {
+
+			@Override
+			public void addViewControllers(ViewControllerRegistry registry) {
+
+				registry.addViewController("/").setViewName("search");
+				registry.addViewController("/monitor").setViewName("monitor");
+			}
+
+			@Override
+			public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
+				argumentResolvers.add(new PageableHandlerMethodArgumentResolver());
+			}
+		};
+	}
+}

src/main/java/org/springframework/data/solr/showcase/product/ProductRepository.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012 - 2014 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 org.springframework.data.solr.showcase.product;
+
+import java.util.Collection;
+
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.solr.core.query.Query.Operator;
+import org.springframework.data.solr.core.query.result.FacetPage;
+import org.springframework.data.solr.core.query.result.HighlightPage;
+import org.springframework.data.solr.repository.Facet;
+import org.springframework.data.solr.repository.Highlight;
+import org.springframework.data.solr.repository.Query;
+import org.springframework.data.solr.repository.SolrCrudRepository;
+import org.springframework.data.solr.showcase.product.model.Product;
+
+/**
+ * @author Christoph Strobl
+ */
+interface ProductRepository extends SolrCrudRepository<Product, String> {
+
+	@Highlight(prefix = "<b>", postfix = "</b>")
+	@Query(fields = { SearchableProductDefinition.ID_FIELD_NAME, SearchableProductDefinition.NAME_FIELD_NAME,
+			SearchableProductDefinition.PRICE_FIELD_NAME, SearchableProductDefinition.FEATURES_FIELD_NAME,
+			SearchableProductDefinition.AVAILABLE_FIELD_NAME }, defaultOperator = Operator.AND)
+	HighlightPage<Product> findByNameIn(Collection<String> names, Pageable page);
+
+	@Facet(fields = { SearchableProductDefinition.NAME_FIELD_NAME })
+	FacetPage<Product> findByNameStartsWith(Collection<String> nameFragments, Pageable pagebale);
+
+}

src/main/java/org/springframework/data/solr/showcase/product/ProductService.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2012 - 2014 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 org.springframework.data.solr.showcase.product;
+
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.solr.core.query.result.FacetPage;
+import org.springframework.data.solr.showcase.product.model.Product;
+
+/**
+ * @author Christoph Strobl
+ */
+public interface ProductService {
+
+	int DEFAULT_PAGE_SIZE = 3;
+
+	Page<Product> findByName(String searchTerm, Pageable pageable);
+
+	Product findById(String id);
+
+	FacetPage<Product> autocompleteNameFragment(String fragment, Pageable pageable);
+
+}