├── src
    ├── main
    │   └── java
    │   │   └── com
    │   │       └── mscharhag
    │   │           └── solr
    │   │               ├── document
    │   │                   ├── Category.java
    │   │                   └── Book.java
    │   │               ├── Application.java
    │   │               └── repository
    │   │                   └── BookRepository.java
    └── test
    │   └── java
    │       └── com
    │           └── mscharhag
    │               └── solr
    │                   └── repository
    │                       └── BookRepositoryTests.java
├── README.md
├── pom.xml
└── LICENSE


/src/main/java/com/mscharhag/solr/document/Category.java:
--------------------------------------------------------------------------------
1 | package com.mscharhag.solr.document;
2 | 
3 | public enum Category {
4 | 	EDUCATION, HISTORY, HUMOR, TECHNOLOGY, ROMANCE, ADVENTURE
5 | }
6 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Spring-data-solr-example
2 | ========================
3 | 
4 | This is an example project to show some of the features of Spring Data Solr. It's the source I used for writing the blog post [Getting started with Spring Data Solr][1]
5 | [1]: http://www.mscharhag.com/2013/11/getting-started-with-spring-data-solr.html
6 | 
7 | Have a look at [BookRepositoryTest][2] to see how to access Solr features with Spring Data Solr.
8 | [2]: https://github.com/mscharhag/Spring-data-solr-example/blob/master/src/test/java/com/mscharhag/solr/repository/BookRepositoryTests.java


--------------------------------------------------------------------------------
/src/main/java/com/mscharhag/solr/Application.java:
--------------------------------------------------------------------------------
 1 | package com.mscharhag.solr;
 2 | 
 3 | import org.apache.solr.client.solrj.SolrServer;
 4 | import org.apache.solr.client.solrj.impl.HttpSolrServer;
 5 | import org.springframework.context.annotation.Bean;
 6 | import org.springframework.context.annotation.ComponentScan;
 7 | import org.springframework.data.solr.core.SolrTemplate;
 8 | import org.springframework.data.solr.repository.config.EnableSolrRepositories;
 9 | 
10 | @ComponentScan
11 | @EnableSolrRepositories("com.mscharhag.solr.repository")
12 | public class Application {
13 | 
14 | 	@Bean
15 | 	public SolrServer solrServer() {
16 | 		return new HttpSolrServer("http://localhost:8983/solr");
17 | 	}
18 | 
19 | 	@Bean
20 | 	public SolrTemplate solrTemplate(SolrServer server) throws Exception {
21 | 		return new SolrTemplate(server);
22 | 	}
23 | }
24 | 


--------------------------------------------------------------------------------
/src/main/java/com/mscharhag/solr/document/Book.java:
--------------------------------------------------------------------------------
 1 | package com.mscharhag.solr.document;
 2 | 
 3 | import java.util.List;
 4 | 
 5 | import org.apache.solr.client.solrj.beans.Field;
 6 | 
 7 | public class Book {
 8 | 	
 9 |     @Field
10 |     private String id;
11 | 
12 |     @Field
13 |     private String name;
14 |     
15 |     @Field
16 |     private String description;
17 |     
18 |     @Field("categories_txt")
19 |     private List<Category> categories;
20 | 
21 |     
22 | 	public String getId() {
23 | 		return id;
24 | 	}
25 | 
26 | 	public void setId(String id) {
27 | 		this.id = id;
28 | 	}
29 | 
30 | 	public String getDescription() {
31 | 		return description;
32 | 	}
33 | 
34 | 	public void setDescription(String description) {
35 | 		this.description = description;
36 | 	}
37 | 
38 | 	public String getName() {
39 | 		return name;
40 | 	}
41 | 
42 | 	public void setName(String title) {
43 | 		this.name = title;
44 | 	}
45 | 	
46 | 	public List<Category> getCategories() {
47 | 		return categories;
48 | 	}
49 | 
50 | 	public void setCategories(List<Category> categories) {
51 | 		this.categories = categories;
52 | 	}
53 | 
54 | 	@Override
55 | 	public String toString() {
56 | 		return "Book [id=" + id + ", description=" + description + ", title=" + name + "]";
57 | 	}
58 | }
59 | 


--------------------------------------------------------------------------------
/src/main/java/com/mscharhag/solr/repository/BookRepository.java:
--------------------------------------------------------------------------------
 1 | package com.mscharhag.solr.repository;
 2 | 
 3 | import java.util.List;
 4 | 
 5 | import org.springframework.data.domain.Page;
 6 | import org.springframework.data.domain.Pageable;
 7 | import org.springframework.data.solr.core.query.result.FacetPage;
 8 | import org.springframework.data.solr.core.query.result.HighlightPage;
 9 | import org.springframework.data.solr.repository.Boost;
10 | import org.springframework.data.solr.repository.Facet;
11 | import org.springframework.data.solr.repository.Highlight;
12 | import org.springframework.data.solr.repository.Query;
13 | import org.springframework.data.solr.repository.SolrCrudRepository;
14 | 
15 | import com.mscharhag.solr.document.Book;
16 | 
17 | public interface BookRepository extends SolrCrudRepository<Book, String> {
18 | 
19 | 	List<Book> findByName(String name);
20 | 	
21 | 	Page<Book> findByNameOrDescription(@Boost(2) String name, String description, Pageable pageable);
22 | 
23 | 	@Query("name:?0")
24 | 	@Facet(fields = { "categories_txt" }, limit = 5)
25 | 	FacetPage<Book> findByNameAndFacetOnCategories(String name, Pageable page);
26 | 	
27 | 	@Highlight(prefix = "<highlight>", postfix = "</highlight>")
28 | 	HighlightPage<Book> findByDescription(String description, Pageable pageable);
29 | 	
30 | }
31 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 | 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 4 | 	<modelVersion>4.0.0</modelVersion>
 5 | 
 6 | 	<groupId>com.mscharhag</groupId>
 7 | 	<artifactId>demo</artifactId>
 8 | 	<version>0.0.1-SNAPSHOT</version>
 9 | 
10 | 	<name>Spring-data-solr-example</name>
11 | 	<description>Spring data solr example</description>
12 | 
13 | 	<parent>
14 | 		<groupId>org.springframework.boot</groupId>
15 | 		<artifactId>spring-boot-starter-parent</artifactId>
16 | 		<version>0.5.0.BUILD-SNAPSHOT</version>
17 | 	</parent>
18 | 
19 | 	<dependencies>
20 | 		<dependency>
21 | 			<groupId>org.springframework.boot</groupId>
22 | 			<artifactId>spring-boot-starter</artifactId>
23 | 		</dependency>
24 | 
25 | 		<dependency>
26 | 			<groupId>org.springframework.boot</groupId>
27 | 			<artifactId>spring-boot-starter-test</artifactId>
28 | 			<scope>test</scope>
29 | 		</dependency>
30 | 		<dependency>
31 | 			<groupId>org.springframework.data</groupId>
32 | 			<artifactId>spring-data-solr</artifactId>
33 | 			<version>1.0.0.RELEASE</version>
34 | 		</dependency>
35 | 	</dependencies>
36 | 
37 | 	<properties>
38 | 		<start-class>com.mscharhag.Application</start-class>
39 | 	</properties>
40 | 
41 | 	<build>
42 | 		<plugins>
43 | 			<plugin>
44 | 				<groupId>org.springframework.boot</groupId>
45 | 				<artifactId>spring-boot-maven-plugin</artifactId>
46 | 			</plugin>
47 | 			<plugin>
48 | 				<artifactId>maven-compiler-plugin</artifactId>
49 | 				<configuration>
50 | 					<source>1.7</source>
51 | 					<target>1.7</target>
52 | 				</configuration>
53 | 			</plugin>
54 | 		</plugins>
55 | 		<resources>
56 | 			<resource>
57 | 				<directory>src/main/resources</directory>
58 | 			</resource>
59 | 		</resources>
60 | 	</build>
61 | 
62 | 	<repositories>
63 | 		<repository>
64 | 			<id>spring-snapshots</id>
65 | 			<name>Spring Snapshots</name>
66 | 			<url>http://repo.springsource.org/snapshot</url>
67 | 			<snapshots>
68 | 				<enabled>true</enabled>
69 | 			</snapshots>
70 | 		</repository>
71 | 		<repository>
72 | 			<id>spring-milestones</id>
73 | 			<name>Spring Milestones</name>
74 | 			<url>http://repo.springsource.org/milestone</url>
75 | 			<snapshots>
76 | 				<enabled>false</enabled>
77 | 			</snapshots>
78 | 		</repository>
79 | 	</repositories>
80 | 	<pluginRepositories>
81 | 		<pluginRepository>
82 | 			<id>spring-snapshots</id>
83 | 			<name>Spring Snapshots</name>
84 | 			<url>http://repo.springsource.org/snapshot</url>
85 | 			<snapshots>
86 | 				<enabled>true</enabled>
87 | 			</snapshots>
88 | 		</pluginRepository>
89 | 		<pluginRepository>
90 | 			<id>spring-milestones</id>
91 | 			<name>Spring Milestones</name>
92 | 			<url>http://repo.springsource.org/milestone</url>
93 | 			<snapshots>
94 | 				<enabled>false</enabled>
95 | 			</snapshots>
96 | 		</pluginRepository>
97 | 	</pluginRepositories>
98 | 
99 | </project>


--------------------------------------------------------------------------------
/src/test/java/com/mscharhag/solr/repository/BookRepositoryTests.java:
--------------------------------------------------------------------------------
  1 | package com.mscharhag.solr.repository;
  2 | 
  3 | import static com.mscharhag.solr.document.Category.ADVENTURE;
  4 | import static com.mscharhag.solr.document.Category.EDUCATION;
  5 | import static com.mscharhag.solr.document.Category.HISTORY;
  6 | import static com.mscharhag.solr.document.Category.HUMOR;
  7 | import static com.mscharhag.solr.document.Category.ROMANCE;
  8 | import static com.mscharhag.solr.document.Category.TECHNOLOGY;
  9 | 
 10 | import java.util.Arrays;
 11 | import java.util.HashMap;
 12 | import java.util.List;
 13 | import java.util.Map;
 14 | 
 15 | import static org.junit.Assert.*;
 16 | 
 17 | import org.junit.Before;
 18 | import org.junit.Test;
 19 | import org.junit.runner.RunWith;
 20 | import org.springframework.beans.factory.annotation.Autowired;
 21 | import org.springframework.boot.test.SpringApplicationContextLoader;
 22 | import org.springframework.data.domain.Page;
 23 | import org.springframework.data.domain.PageRequest;
 24 | import org.springframework.data.solr.core.query.result.FacetEntry;
 25 | import org.springframework.data.solr.core.query.result.FacetPage;
 26 | import org.springframework.data.solr.core.query.result.HighlightEntry;
 27 | import org.springframework.data.solr.core.query.result.HighlightEntry.Highlight;
 28 | import org.springframework.data.solr.core.query.result.HighlightPage;
 29 | import org.springframework.test.context.ContextConfiguration;
 30 | import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 31 | 
 32 | import com.mscharhag.solr.Application;
 33 | import com.mscharhag.solr.document.Book;
 34 | import com.mscharhag.solr.document.Category;
 35 | import com.mscharhag.solr.repository.BookRepository;
 36 | 
 37 | @RunWith(SpringJUnit4ClassRunner.class)
 38 | @ContextConfiguration(classes = Application.class, loader=SpringApplicationContextLoader.class)
 39 | public class BookRepositoryTests {
 40 | 	
 41 | 	@Autowired
 42 | 	private BookRepository bookRepository;
 43 | 	
 44 | 	
 45 | 	@Before
 46 | 	public void before() {
 47 | 		createSampleData();
 48 | 	}
 49 | 	
 50 | 	
 51 | 	@Test
 52 | 	public void findByName() {
 53 | 		List<Book> books = bookRepository.findByName("Island");
 54 | 		
 55 | 		// Books with IDs 01, 02, 05, 08 contain "Island" in their name 
 56 | 		assertEquals(books.size(), 4);
 57 | 		assertTrue(containsBooksWithIds(books, "01", "02", "05", "08"));
 58 | 	}
 59 | 	
 60 | 	
 61 | 	@Test
 62 | 	public void findByNameOrDescription() {
 63 | 		Page<Book> booksPage = bookRepository.findByNameOrDescription("Island", "Island", new PageRequest(0, 10));
 64 | 		
 65 | 		// the following books contain the string "island" in their name or description: 01, 02, 05, 07, 08
 66 | 		List<Book> books = booksPage.getContent();
 67 | 		assertEquals(5, books.size());
 68 | 		assertTrue(containsBooksWithIds(books, "01", "02", "05", "07", "08"));
 69 | 		
 70 | 		// If the book name contains the string "Island" within the name, the book ranking is boosted by 2 (see @Boost in repository method)
 71 | 		// Book with ID 07 is the only book which name does not contain "Island" so it should be ranked last
 72 | 		assertEquals("07", books.get(4).getId());
 73 | 	}
 74 | 	
 75 | 	
 76 | 	@Test
 77 | 	public void findByNameAndFacetOnCategories() {
 78 | 		FacetPage<Book> booksFacetPage = bookRepository.findByNameAndFacetOnCategories("Island", new PageRequest(0, 2));
 79 | 
 80 | 		// There are 4 books which contain "Island" in their name. However, only the first 2 books are returned because 
 81 | 		// a page with size 2 is requested. The next two books could be requested using "new PageRequest(1, 2)" 
 82 | 		
 83 | 		assertEquals(2, booksFacetPage.getNumberOfElements());
 84 | 		
 85 | 		// 3 of these 4 books are categorized as Adventure
 86 | 		// 2 of these 4 books are categorized as Humor
 87 | 		// 1 of these 4 books is categorized as Romance
 88 | 		Map<Category, Long> categoryFacetCounts = getCategoryFacetCounts(booksFacetPage);
 89 | 		assertEquals(new Long(3), categoryFacetCounts.get(ADVENTURE));
 90 | 		assertEquals(new Long(2), categoryFacetCounts.get(HUMOR));
 91 | 		assertEquals(new Long(1), categoryFacetCounts.get(ROMANCE));
 92 | 	}
 93 | 	
 94 | 	
 95 | 	@Test
 96 | 	public void findByDescription() {
 97 | 		HighlightPage<Book> booksHighlightPage = bookRepository.findByDescription("cookies", new PageRequest(0, 10));
 98 | 		booksHighlightPage.getContent();
 99 | 		assertTrue(containsSnipplet(booksHighlightPage, "How to handle <highlight>cookies</highlight> in web applications"));
100 | 		assertTrue(containsSnipplet(booksHighlightPage, "Bake your own <highlight>cookies</highlight>, on a secret island!"));
101 | 	}
102 | 	
103 | 	
104 | 	private boolean containsSnipplet(HighlightPage<Book> booksHighlightPage, String snippletToCheck) {
105 | 		for (HighlightEntry<Book> he : booksHighlightPage.getHighlighted()) {
106 | 			// A HighlightEntry belongs to an Entity (Book) and may have multiple highlighted fields (description)
107 | 			for (Highlight highlight : he.getHighlights()) {
108 | 				for (String snipplet : highlight.getSnipplets()) {
109 | 					
110 | 					if (snipplet.equals(snippletToCheck)) {
111 | 						return true;
112 | 					}
113 | 				}
114 | 			}
115 | 		}
116 | 		return false;
117 | 	}
118 | 	
119 | 	
120 | 	private void createSampleData() {
121 | 		if (bookRepository.findOne("01") != null) {
122 | 			System.out.println("Not adding test data to solr index. Data already exists");
123 | 			return;
124 | 		}
125 | 		addBookToIndex("01", "Treasure Island",     "Best seller by R.L.S.",                             ADVENTURE);
126 | 		addBookToIndex("02", "Treasure Island 2.0", "Humorous remake of the famous best seller",         ADVENTURE, HUMOR);
127 | 		addBookToIndex("03", "Solr for dummies",    "Get started with solr",                             EDUCATION, HUMOR, TECHNOLOGY);
128 | 		addBookToIndex("04", "Moon landing",        "All facts about Apollo 11, a best seller",          HISTORY, EDUCATION);
129 | 		addBookToIndex("05", "Spring Island",       "The perfect island romance..",                      ROMANCE);
130 | 		addBookToIndex("06", "Refactoring",         "It's about improving the design of existing code.", TECHNOLOGY);
131 | 		addBookToIndex("07", "Baking for dummies",  "Bake your own cookies, on a secret island!",        EDUCATION, HUMOR);
132 | 		addBookToIndex("08", "The Pirate Island",   "Oh noes, the pirates are coming!",                  ADVENTURE, HUMOR);
133 | 		addBookToIndex("09", "Blackbeard",          "It's the pirate Edward Teach!",                     ADVENTURE, HISTORY);
134 | 		addBookToIndex("10", "Handling Cookies",    "How to handle cookies in web applications",         TECHNOLOGY);
135 | 	}
136 | 	
137 | 	
138 | 	private void addBookToIndex(String id, String name, String description, Category... categories) {
139 | 		Book book = new Book();
140 | 		book.setName(name);
141 | 		book.setDescription(description);
142 | 		book.setCategories(Arrays.asList(categories));
143 | 		book.setId(id);
144 | 		bookRepository.save(book);
145 | 		System.out.println("Added book with id " + id + " to index");
146 | 	}
147 | 	
148 | 	
149 | 	private Map<Category, Long> getCategoryFacetCounts(FacetPage<Book> booksFacetPage) {
150 | 		Map<Category, Long> facetCounts = new HashMap<Category, Long>();
151 | 		for (Page<? extends FacetEntry> p : booksFacetPage.getAllFacets()) {
152 | 			for (FacetEntry facetEntry : p.getContent()) {
153 | 				Category category = Category.valueOf(facetEntry.getValue().toUpperCase());
154 | 				facetCounts.put(category, facetEntry.getValueCount());
155 | 			}
156 | 		}
157 | 		return facetCounts;
158 | 	}
159 | 
160 | 	
161 | 	private boolean containsBooksWithIds(List<Book> books, String... idsToCheck) {
162 | 		String[] bookIds = new String[books.size()];
163 | 		for (int i = 0; i < books.size(); i++) {
164 | 			bookIds[i] = books.get(i).getId();
165 | 		}
166 | 		Arrays.sort(bookIds);
167 | 		Arrays.sort(idsToCheck);
168 | 		return Arrays.equals(bookIds, idsToCheck);
169 | 	}
170 | 
171 | }
172 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 
203 | 


--------------------------------------------------------------------------------