org.springframework.data.solr.core

Class SolrTemplate

java.lang.Object

org.springframework.data.solr.core.SolrTemplate

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, SolrOperations

public class SolrTemplate
extends Object
implements SolrOperations, InitializingBean, ApplicationContextAware

Implementation of SolrOperations

Author:

Christoph Strobl, Joachim Uhrlass, Francisco Spaeth, Shiradwade Sateesh Krishna

Constructor Summary

Constructors

Constructor and Description
SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient)
SolrTemplate(SolrClientFactory solrClientFactory)
SolrTemplate(SolrClientFactory solrClientFactory, RequestMethod requestMethod)
SolrTemplate(SolrClientFactory solrClientFactory, SolrConverter solrConverter)
SolrTemplate(SolrClientFactory solrClientFactory, SolrConverter solrConverter, RequestMethod defaultRequestMethod)
SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient, String core)
SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient, String core, RequestMethod requestMethod)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	assertNoCollection(Object o)
void	commit() Send commit command SolrClient.commit()
org.apache.solr.common.SolrInputDocument	convertBeanToSolrInputDocument(Object bean) Convert given bean into a solrj InputDocument
<T> List<T>	convertQueryResponseToBeans(org.apache.solr.client.solrj.response.QueryResponse response, Class<T> targetClass)
<T> List<T>	convertSolrDocumentListToBeans(org.apache.solr.common.SolrDocumentList documents, Class<T> targetClass)
<T> T	convertSolrDocumentToBean(org.apache.solr.common.SolrDocument document, Class<T> targetClass)
long	count(SolrDataQuery query) return number of elements found by for given query
long	count(SolrDataQuery query, RequestMethod method) return number of elements found by for given query
org.apache.solr.client.solrj.response.UpdateResponse	delete(SolrDataQuery query) Find and delete all objects matching the provided Query
org.apache.solr.client.solrj.response.UpdateResponse	deleteById(Collection<String> ids) Delete objects with given ids
org.apache.solr.client.solrj.response.UpdateResponse	deleteById(String id) Detele the one object with provided id
<T> T	execute(SolrCallback<T> action) Execute action within callback
<T> Collection<T>	getById(Collection<? extends Serializable> ids, Class<T> clazz) Executes a realtime get using given ids.
<T> T	getById(Serializable id, Class<T> clazz) Executes a realtime get using given id.
SolrConverter	getConverter()
RequestMethod	getDefaultRequestMethod()
static PersistenceExceptionTranslator	getExceptionTranslator()
Set<SolrPersistentEntitySchemaCreator.Feature>	getSchemaCreationFeatures()
String	getSchemaName(String collectionName)
org.apache.solr.client.solrj.SolrClient	getSolrClient() Get the underlying SolrClient instance
String	getSolrCore()
org.apache.solr.client.solrj.response.SolrPingResponse	ping() Execute ping against SolrClient and return duration in msec
<T> Cursor<T>	queryForCursor(Query query, Class<T> clazz) Executes the given Query and returns an open Cursor allowing to iterate of results, dynamically fetching additional ones if required.
<T> FacetPage<T>	queryForFacetPage(FacetQuery query, Class<T> clazz) Execute a facet query against solr facet result will be returned along with query result within the FacetPage
<T> FacetPage<T>	queryForFacetPage(FacetQuery query, Class<T> clazz, RequestMethod method) Execute a facet query against solr facet result will be returned along with query result within the FacetPage
<T> GroupPage<T>	queryForGroupPage(Query query, Class<T> clazz) Execute the query against solr and return result as GroupPage
<T> GroupPage<T>	queryForGroupPage(Query query, Class<T> clazz, RequestMethod method) Execute the query against solr and return result as GroupPage
<T> HighlightPage<T>	queryForHighlightPage(HighlightQuery query, Class<T> clazz) Execute a query and highlight matches in result
<T> HighlightPage<T>	queryForHighlightPage(HighlightQuery query, Class<T> clazz, RequestMethod method) Execute a query and highlight matches in result
<T> T	queryForObject(Query query, Class<T> clazz) Execute the query against solr and return the first returned object
<T> T	queryForObject(Query query, Class<T> clazz, RequestMethod method) Execute the query against solr and return the first returned object
<T> ScoredPage<T>	queryForPage(Query query, Class<T> clazz) Execute the query against solr and retrun result as Page
<T> ScoredPage<T>	queryForPage(Query query, Class<T> clazz, RequestMethod method) Execute the query against solr and retrun result as Page
<T> StatsPage<T>	queryForStatsPage(Query query, Class<T> clazz) Execute the query against Solr and return result as StatsPage.
<T> StatsPage<T>	queryForStatsPage(Query query, Class<T> clazz, RequestMethod method) Execute the query against Solr and return result as StatsPage.
TermsPage	queryForTermsPage(TermsQuery query) Execute query using terms handler
TermsPage	queryForTermsPage(TermsQuery query, RequestMethod method) Execute query using terms handler
void	registerQueryParser(Class<? extends SolrDataQuery> clazz, QueryParser queryParser)
void	rollback() send rollback command SolrClient.rollback()
org.apache.solr.client.solrj.response.UpdateResponse	saveBean(Object obj) Execute add operation against solr, which will do either insert or update
org.apache.solr.client.solrj.response.UpdateResponse	saveBean(Object objectToAdd, int commitWithinMs) Execute add operation against solr, which will do either insert or update with support for commitWithin strategy
org.apache.solr.client.solrj.response.UpdateResponse	saveBeans(Collection<?> beans) Add a collection of beans to solr, which will do either insert or update
org.apache.solr.client.solrj.response.UpdateResponse	saveBeans(Collection<?> beansToAdd, int commitWithinMs) Add a collection of beans to solr, which will do either insert or update with support for commitWithin strategy
org.apache.solr.client.solrj.response.UpdateResponse	saveDocument(org.apache.solr.common.SolrInputDocument document) Add a solrj input document to solr, which will do either insert or update
org.apache.solr.client.solrj.response.UpdateResponse	saveDocument(org.apache.solr.common.SolrInputDocument documentToAdd, int commitWithinMs) Add a solrj input document to solr, which will do either insert or update with support for commitWithin strategy
org.apache.solr.client.solrj.response.UpdateResponse	saveDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents) Add multiple solrj input documents to solr, which will do either insert or update
org.apache.solr.client.solrj.response.UpdateResponse	saveDocuments(Collection<org.apache.solr.common.SolrInputDocument> documentsToAdd, int commitWithinMs) Add multiple solrj input documents to solr, which will do either insert or update with support for commitWithin strategy
void	setApplicationContext(ApplicationContext applicationContext)
void	setMappingContext(MappingContext<? extends SolrPersistentEntity<?>,SolrPersistentProperty> mappingContext)
void	setSchemaCreationFeatures(Collection<SolrPersistentEntitySchemaCreator.Feature> schemaCreationFeatures)
void	setSolrConverter(SolrConverter solrConverter)
void	setSolrCore(String solrCore)
void	softCommit() Send soft commmit command SolrClient.commit(boolean, boolean, boolean)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SolrTemplate

public SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient)

SolrTemplate

public SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient,
                    String core)

SolrTemplate

public SolrTemplate(org.apache.solr.client.solrj.SolrClient solrClient,
                    String core,
                    RequestMethod requestMethod)

SolrTemplate

public SolrTemplate(SolrClientFactory solrClientFactory)

SolrTemplate

public SolrTemplate(SolrClientFactory solrClientFactory,
                    RequestMethod requestMethod)

SolrTemplate

public SolrTemplate(SolrClientFactory solrClientFactory,
                    SolrConverter solrConverter)

SolrTemplate

public SolrTemplate(SolrClientFactory solrClientFactory,
                    SolrConverter solrConverter,
                    RequestMethod defaultRequestMethod)

Parameters:

solrClientFactory - must not be null.

solrConverter - must not be null.

defaultRequestMethod - can be null. Will be defaulted to RequestMethod.GET

Since:

2.0

Method Detail

execute

public <T> T execute(SolrCallback<T> action)

Description copied from interface: SolrOperations

Execute action within callback

Specified by:

execute in interface SolrOperations

Returns:

ping

public org.apache.solr.client.solrj.response.SolrPingResponse ping()

Description copied from interface: SolrOperations

Execute ping against SolrClient and return duration in msec

Specified by:

ping in interface SolrOperations

Returns:

count

public long count(SolrDataQuery query)

Description copied from interface: SolrOperations

return number of elements found by for given query

Specified by:

count in interface SolrOperations

Returns:

count

public long count(SolrDataQuery query,
                  RequestMethod method)

Description copied from interface: SolrOperations

return number of elements found by for given query

Specified by:

count in interface SolrOperations

method - must not be null.

Returns:

saveBean

public org.apache.solr.client.solrj.response.UpdateResponse saveBean(Object obj)

Description copied from interface: SolrOperations

Execute add operation against solr, which will do either insert or update

Specified by:

saveBean in interface SolrOperations

Returns:

saveBean

public org.apache.solr.client.solrj.response.UpdateResponse saveBean(Object objectToAdd,
                                                                     int commitWithinMs)

Description copied from interface: SolrOperations

Execute add operation against solr, which will do either insert or update with support for commitWithin strategy

Specified by:

saveBean in interface SolrOperations

Returns:

saveBeans

public org.apache.solr.client.solrj.response.UpdateResponse saveBeans(Collection<?> beans)

Description copied from interface: SolrOperations

Add a collection of beans to solr, which will do either insert or update

Specified by:

saveBeans in interface SolrOperations

Returns:

saveBeans

public org.apache.solr.client.solrj.response.UpdateResponse saveBeans(Collection<?> beansToAdd,
                                                                      int commitWithinMs)

Description copied from interface: SolrOperations

Add a collection of beans to solr, which will do either insert or update with support for commitWithin strategy

Specified by:

saveBeans in interface SolrOperations

Returns:

saveDocument

public org.apache.solr.client.solrj.response.UpdateResponse saveDocument(org.apache.solr.common.SolrInputDocument document)

Description copied from interface: SolrOperations

Add a solrj input document to solr, which will do either insert or update

Specified by:

saveDocument in interface SolrOperations

Returns:

saveDocument

public org.apache.solr.client.solrj.response.UpdateResponse saveDocument(org.apache.solr.common.SolrInputDocument documentToAdd,
                                                                         int commitWithinMs)

Description copied from interface: SolrOperations

Add a solrj input document to solr, which will do either insert or update with support for commitWithin strategy

Specified by:

saveDocument in interface SolrOperations

Returns:

saveDocuments

public org.apache.solr.client.solrj.response.UpdateResponse saveDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents)

Description copied from interface: SolrOperations

Add multiple solrj input documents to solr, which will do either insert or update

Specified by:

saveDocuments in interface SolrOperations

Returns:

saveDocuments

public org.apache.solr.client.solrj.response.UpdateResponse saveDocuments(Collection<org.apache.solr.common.SolrInputDocument> documentsToAdd,
                                                                          int commitWithinMs)

Description copied from interface: SolrOperations

Add multiple solrj input documents to solr, which will do either insert or update with support for commitWithin strategy

Specified by:

saveDocuments in interface SolrOperations

Returns:

delete

public org.apache.solr.client.solrj.response.UpdateResponse delete(SolrDataQuery query)

Description copied from interface: SolrOperations

Find and delete all objects matching the provided Query

Specified by:

delete in interface SolrOperations

Returns:

deleteById

public org.apache.solr.client.solrj.response.UpdateResponse deleteById(String id)

Description copied from interface: SolrOperations

Detele the one object with provided id

Specified by:

deleteById in interface SolrOperations

Returns:

deleteById

public org.apache.solr.client.solrj.response.UpdateResponse deleteById(Collection<String> ids)

Description copied from interface: SolrOperations

Delete objects with given ids

Specified by:

deleteById in interface SolrOperations

Returns:

queryForObject

public <T> T queryForObject(Query query,
                            Class<T> clazz)

Description copied from interface: SolrOperations

Execute the query against solr and return the first returned object

Specified by:

queryForObject in interface SolrOperations

Returns:

the first matching object

queryForObject

public <T> T queryForObject(Query query,
                            Class<T> clazz,
                            RequestMethod method)

Description copied from interface: SolrOperations

Execute the query against solr and return the first returned object

Specified by:

queryForObject in interface SolrOperations

method - must not be null.

Returns:

the first matching object

queryForPage

public <T> ScoredPage<T> queryForPage(Query query,
                                      Class<T> clazz)

Description copied from interface: SolrOperations

Execute the query against solr and retrun result as Page

Specified by:

queryForPage in interface SolrOperations

Returns:

queryForPage

public <T> ScoredPage<T> queryForPage(Query query,
                                      Class<T> clazz,
                                      RequestMethod method)

Description copied from interface: SolrOperations

Execute the query against solr and retrun result as Page

Specified by:

queryForPage in interface SolrOperations

Parameters:

query - must not be null.

clazz - must not be null.

method - must not be null.

Returns:

queryForGroupPage

public <T> GroupPage<T> queryForGroupPage(Query query,
                                          Class<T> clazz)

Description copied from interface: SolrOperations

Execute the query against solr and return result as GroupPage

Specified by:

queryForGroupPage in interface SolrOperations

Returns:

queryForGroupPage

public <T> GroupPage<T> queryForGroupPage(Query query,
                                          Class<T> clazz,
                                          RequestMethod method)

Description copied from interface: SolrOperations

Execute the query against solr and return result as GroupPage

Specified by:

queryForGroupPage in interface SolrOperations

method - must not be null.

Returns:

queryForStatsPage

public <T> StatsPage<T> queryForStatsPage(Query query,
                                          Class<T> clazz)

Description copied from interface: SolrOperations

Execute the query against Solr and return result as StatsPage.

Specified by:

queryForStatsPage in interface SolrOperations

Parameters:

query - must not be null.

clazz - must not be null.

Returns:

queryForStatsPage

public <T> StatsPage<T> queryForStatsPage(Query query,
                                          Class<T> clazz,
                                          RequestMethod method)

Description copied from interface: SolrOperations

Execute the query against Solr and return result as StatsPage.

Specified by:

queryForStatsPage in interface SolrOperations

Parameters:

query - must not be null.

clazz - must not be null.

method - must not be null.

Returns:

queryForFacetPage

public <T> FacetPage<T> queryForFacetPage(FacetQuery query,
                                          Class<T> clazz)

Description copied from interface: SolrOperations

Execute a facet query against solr facet result will be returned along with query result within the FacetPage

Specified by:

queryForFacetPage in interface SolrOperations

Returns:

queryForFacetPage

public <T> FacetPage<T> queryForFacetPage(FacetQuery query,
                                          Class<T> clazz,
                                          RequestMethod method)

Description copied from interface: SolrOperations

Execute a facet query against solr facet result will be returned along with query result within the FacetPage

Specified by:

queryForFacetPage in interface SolrOperations

method - must not be null.

Returns:

queryForHighlightPage

public <T> HighlightPage<T> queryForHighlightPage(HighlightQuery query,
                                                  Class<T> clazz)

Description copied from interface: SolrOperations

Execute a query and highlight matches in result

Specified by:

queryForHighlightPage in interface SolrOperations

Returns:

queryForHighlightPage

public <T> HighlightPage<T> queryForHighlightPage(HighlightQuery query,
                                                  Class<T> clazz,
                                                  RequestMethod method)

Description copied from interface: SolrOperations

Execute a query and highlight matches in result

Specified by:

queryForHighlightPage in interface SolrOperations

method - must not be null.

Returns:

queryForTermsPage

public TermsPage queryForTermsPage(TermsQuery query)

Description copied from interface: SolrOperations

Execute query using terms handler

Specified by:

queryForTermsPage in interface SolrOperations

Returns:

queryForTermsPage

public TermsPage queryForTermsPage(TermsQuery query,
                                   RequestMethod method)

Description copied from interface: SolrOperations

Execute query using terms handler

Specified by:

queryForTermsPage in interface SolrOperations

method - must not be null.

Returns:

commit

public void commit()

Description copied from interface: SolrOperations

Send commit command SolrClient.commit()

Specified by:

commit in interface SolrOperations

softCommit

public void softCommit()

Description copied from interface: SolrOperations

Send soft commmit command SolrClient.commit(boolean, boolean, boolean)

Specified by:

softCommit in interface SolrOperations

rollback

public void rollback()

Description copied from interface: SolrOperations

send rollback command SolrClient.rollback()

Specified by:

rollback in interface SolrOperations

convertBeanToSolrInputDocument

public org.apache.solr.common.SolrInputDocument convertBeanToSolrInputDocument(Object bean)

Description copied from interface: SolrOperations

Convert given bean into a solrj InputDocument

Specified by:

convertBeanToSolrInputDocument in interface SolrOperations

Returns:

getSchemaName

public String getSchemaName(String collectionName)

Parameters:

collectionName -

Returns:

Since:

1.3

queryForCursor

public <T> Cursor<T> queryForCursor(Query query,
                                    Class<T> clazz)

Description copied from interface: SolrOperations

Executes the given Query and returns an open Cursor allowing to iterate of results, dynamically fetching additional ones if required.

Specified by:

queryForCursor in interface SolrOperations

Returns:

getById

public <T> Collection<T> getById(Collection<? extends Serializable> ids,
                                 Class<T> clazz)

Description copied from interface: SolrOperations

Executes a realtime get using given ids.

Specified by:

getById in interface SolrOperations

Returns:

getById

public <T> T getById(Serializable id,
                     Class<T> clazz)

Description copied from interface: SolrOperations

Executes a realtime get using given id.

Specified by:

getById in interface SolrOperations

Returns:

convertQueryResponseToBeans

public <T> List<T> convertQueryResponseToBeans(org.apache.solr.client.solrj.response.QueryResponse response,
                                               Class<T> targetClass)

convertSolrDocumentListToBeans

public <T> List<T> convertSolrDocumentListToBeans(org.apache.solr.common.SolrDocumentList documents,
                                                  Class<T> targetClass)

convertSolrDocumentToBean

public <T> T convertSolrDocumentToBean(org.apache.solr.common.SolrDocument document,
                                       Class<T> targetClass)

assertNoCollection

protected void assertNoCollection(Object o)

getSolrClient

public final org.apache.solr.client.solrj.SolrClient getSolrClient()

Description copied from interface: SolrOperations

Get the underlying SolrClient instance

Specified by:

getSolrClient in interface SolrOperations

Returns:

getConverter

public SolrConverter getConverter()

Specified by:

getConverter in interface SolrOperations

Returns:

Converter in use

getExceptionTranslator

public static PersistenceExceptionTranslator getExceptionTranslator()

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

registerQueryParser

public void registerQueryParser(Class<? extends SolrDataQuery> clazz,
                                QueryParser queryParser)

setSolrConverter

public void setSolrConverter(SolrConverter solrConverter)

getSolrCore

public String getSolrCore()

setSolrCore

public void setSolrCore(String solrCore)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

setMappingContext

public void setMappingContext(MappingContext<? extends SolrPersistentEntity<?>,SolrPersistentProperty> mappingContext)

Parameters:

mappingContext -

Since:

1.3

setSchemaCreationFeatures

public void setSchemaCreationFeatures(Collection<SolrPersistentEntitySchemaCreator.Feature> schemaCreationFeatures)

Parameters:

schemaCreationFeatures -

Since:

1.3

getSchemaCreationFeatures

public Set<SolrPersistentEntitySchemaCreator.Feature> getSchemaCreationFeatures()

Returns:

Since:

1.3

getDefaultRequestMethod

public RequestMethod getDefaultRequestMethod()

Returns:

never null.