We have learned how we can configure Spring Data Solr. We have also learned how we can add new documents to the Solr index, update the information of existing documents and delete documents from the Solr index. Now it is time to move forward and learn how we can search information from the Solr index by using Spring Data Solr. The requirements of our search function are given in the following:<\/p>\n
We can implement the search function by following these steps:<\/p>\n
Let\u2019s move on and find out how we can implement the search function by using query methods.<\/p>\n
Note:<\/strong> These blog entries provide additional information which helps us the understand the concepts described in this blog entry:<\/p>\n Query methods are methods which are<\/p>\n We can create query methods with Spring Data Solr by using the following techniques:<\/p>\n These techniques are described with more details in the following subsections.<\/p>\n The query generation from the method name is a query generation strategy where the executed query is parsed from the name of the query method.<\/p>\n We can get more information about the property expressions and the repository keywords by reading the following resources:<\/p>\n As we remember, our search function must return all todo entries which title or description contains the given search term. Also, our document class has two properties which we are using in this query. These properties are called title<\/em> and description<\/em>. We can create the method name which fulfils the requirements of our search function by following these steps:<\/p>\n The source code of the TodoDocumentRepository<\/em> interface looks as follows:<\/p>\n Note:<\/strong> This query method will not work if the search term contains more than one word. Named queries are queries which are declared in a separate properties file and wired to the correct query method. The rules concerning the properties file used to declare the named queries are described in the following:<\/p>\n Named queries which are configured in the properties files are matched with the query methods of our repository interface by using the following rules:<\/p>\n We can implement query method with named queries by following these steps:<\/p>\n These steps are described with more details in the following.<\/p>\n We can create a named query which fulfils the requirements of our search function by following these steps:<\/p>\n The content of the META-INF\/solr-named-query.properties<\/em> file looks as follows:<\/p>\n We can create the query method which uses the created named query by following these steps:<\/p>\n The source code of the TodoDocumentRepository<\/em> interface looks as follows:<\/p>\n The @Query<\/em> annotation<\/a> can be used to specify the query which is executed when a query method is called. We can create the query method which fulfils the requirements of our search function by following these steps:<\/p>\n The source code of the TodoDocumentRepository<\/em> interface looks as follows:<\/p>\n We can use the created query method by following these steps:<\/p>\n These steps are described with more details in the following subsections.<\/p>\n Our first step is to declare the search method in the TodoIndexService<\/em> interface. The relevant part of the TodoIndexService<\/em> interface looks as follows:<\/p>\n Our second step is to implement the search()<\/em> method. Our implementation is rather simple. It obtains a list of TodoDocument<\/em> objects by calling the correct method of the TodoDocumentRepository<\/em> interface and returns that list.<\/p>\n The name of the query method depends from the technique used to create the query method. The different implementations are described in the following.<\/p>\n When we are generating the query from the name of the query method, our implementation obtains a list of TodoDocument<\/em> objects by calling the findByTitleContainsOrDescriptionContains()<\/em> method of the TodoDocumentRepository<\/em> interface and returns that list.<\/p>\n The relevant part of the RepositoryTodoIndexService<\/em> class looks as follows:<\/p>\n If we are using named queries, our implementation gets a list of TodoDocument<\/em> objects by calling the findByNamedQuery()<\/em> method of the TodoDocumentRepository<\/em> interface and returns that list.<\/p>\n The relevant part of the RepositoryTodoIndexService<\/em> class looks as follows:<\/p>\n When we are using the @Query<\/em> annotation, our implementation obtains a list of TodoDocument<\/em> objects by calling the findByQueryAnnotation()<\/em> method of the TodoDocumentRepository<\/em> interface and returns that list.<\/p>\n The relevant part of the RepositoryTodoIndexService<\/em> class looks as follows:<\/p>\n The obvious question is:<\/p>\n What is the best way to add query methods to our Spring Data Solr repositories?<\/p>\n We can use the following guidelines when we are deciding the correct query creation technique for our query method:<\/p>\n We have now learned how we can create static queries with Spring Data Solr. This blog entry has taught us two things:<\/p>\n The example application which demonstrates the concepts described in this blog entry is available at Github<\/a>. In the next part of this tutorial we will learn how we can add custom functionality to a single repository<\/a>. We have learned how we can configure Spring Data Solr. We have also learned how we can add new documents to the Solr index, update the information of existing documents and delete documents from the Solr index. Now it is time to move forward and learn how we can search information from the Solr index …<\/p>\n","protected":false},"author":429,"featured_media":80,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[470,30,321],"class_list":["post-13188","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-enterprise-java","tag-apache-solr","tag-spring","tag-spring-data"],"yoast_head":"\n\n
Creating the Query Method<\/h2>\n
\n
\n
Query Generation from the Method Name<\/h4>\n
\n
\n
\n
import org.springframework.data.solr.repository.SolrCrudRepository;\r\nimport java.util.List;\r\n\r\npublic interface TodoDocumentRepository extends SolrCrudRepository<TodoDocument, String> {\r\n\r\n public List<TodoDocument> findByTitleContainsOrDescriptionContains(String title, String description);\r\n}<\/pre>\nNamed Queries<\/h4>\n
\n
\n
\n
Specifying the Named Query<\/h4>\n
\n
TodoDocument.findByNamedQuery=title:*?0* OR description:*?0*<\/pre>\n
Creating the Query Method<\/h2>\n
\n
import org.springframework.data.solr.repository.Query;\r\nimport org.springframework.data.solr.repository.SolrCrudRepository;\r\n\r\nimport java.util.List;\r\n\r\npublic interface TodoDocumentRepository extends SolrCrudRepository<TodoDocument, String> {\r\n\r\n @Query(name = \"TodoDocument.findByNamedQuery\")\r\n public List<TodoDocument> findByNamedQuery(String searchTerm);\r\n}<\/pre>\n@Query Annotation<\/h4>\n
\n
import org.springframework.data.solr.repository.Query;\r\nimport org.springframework.data.solr.repository.SolrCrudRepository;\r\n\r\nimport java.util.List;\r\n\r\npublic interface TodoDocumentRepository extends SolrCrudRepository<TodoDocument, String> {\r\n\r\n @Query(\"title:*?0* OR description:*?0*\")\r\n public List<TodoDocument> findByQueryAnnotation(String searchTerm);\r\n}<\/pre>\nUsing the Created Query Method<\/h2>\n
\n
Declaring the Search Method<\/h4>\n
import java.util.List;\r\n\r\npublic interface TodoIndexService {\r\n\r\n public List<TodoDocument> search(String searchTerm);\r\n}<\/pre>\nImplementing the Search Method<\/h4>\n
Query Generation from the Method Name<\/h4>\n
import org.springframework.stereotype.Service;\r\nimport javax.annotation.Resource;\r\nimport java.util.List;\r\n\r\n@Service\r\npublic class RepositoryTodoIndexService implements TodoIndexService {\r\n\r\n @Resource\r\n private TodoDocumentRepository repository;\r\n\r\n @Override\r\n public List<TodoDocument> search(String searchTerm) {\r\n return repository.findByTitleContainsOrDescriptionContains(searchTerm, searchTerm);\r\n }\r\n}<\/pre>\nNamed Queries<\/h4>\n
import org.springframework.stereotype.Service;\r\nimport javax.annotation.Resource;\r\nimport java.util.List;\r\n\r\n@Service\r\npublic class RepositoryTodoIndexService implements TodoIndexService {\r\n\r\n @Resource\r\n private TodoDocumentRepository repository;\r\n\r\n @Override\r\n public List<TodoDocument> search(String searchTerm) {\r\n return repository.findByNamedQuery(searchTerm);\r\n }\r\n}<\/pre>\n@Query Annotation<\/h4>\n
import org.springframework.stereotype.Service;\r\nimport javax.annotation.Resource;\r\nimport java.util.List;\r\n\r\n@Service\r\npublic class RepositoryTodoIndexService implements TodoIndexService {\r\n\r\n @Resource\r\n private TodoDocumentRepository repository;\r\n\r\n @Override\r\n public List<TodoDocument> search(String searchTerm) {\r\n return repository.findByQueryAnnotation(searchTerm);\r\n }\r\n}<\/pre>\nSelecting the Correct Query Creation Technique<\/h2>\n
\n
Summary<\/h2>\n
\n
\n <\/p>\n