org.springframework.data.solr.core

Interface SolrOperations

All Known Implementing Classes:

SolrTemplate

public interface SolrOperations

Interface that specifies a basic set of Solr operations.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	commit() Send commit command SolrClient.commit()
org.apache.solr.common.SolrInputDocument	convertBeanToSolrInputDocument(Object bean) Convert given bean into a solrj InputDocument
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> id) 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()
org.apache.solr.client.solrj.SolrClient	getSolrClient() Get the underlying SolrClient instance
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	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 obj, 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<?> beans, 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 document, 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> documents, int commitWithinMs) Add multiple solrj input documents to solr, which will do either insert or update with support for commitWithin strategy
void	softCommit() Send soft commmit command SolrClient.commit(boolean, boolean, boolean)

Method Detail

getSolrClient

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

Get the underlying SolrClient instance

Returns:

ping

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

Execute ping against SolrClient and return duration in msec

Returns:

count

long count(SolrDataQuery query)

return number of elements found by for given query

Parameters:

query -

Returns:

count

long count(SolrDataQuery query,
           RequestMethod method)

return number of elements found by for given query

Parameters:

query -

method - must not be null.

Returns:

Since:

2.0

saveBean

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

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

Parameters:

obj -

Returns:

saveBean

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

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

Parameters:

obj -

commitWithinMs -

Returns:

saveBeans

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

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

Parameters:

beans -

Returns:

saveBeans

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

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

Parameters:

beans -

commitWithinMs -

Returns:

saveDocument

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

Parameters:

document -

Returns:

saveDocument

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

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

Parameters:

document -

commitWithinMs -

Returns:

saveDocuments

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

Parameters:

documents -

Returns:

saveDocuments

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

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

Parameters:

documents -

Returns:

delete

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

Find and delete all objects matching the provided Query

Parameters:

query -

Returns:

deleteById

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

Detele the one object with provided id

Parameters:

id -

Returns:

deleteById

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

Delete objects with given ids

Parameters:

id -

Returns:

queryForObject

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

Execute the query against solr and return the first returned object

Parameters:

query -

clazz -

Returns:

the first matching object

queryForObject

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

Execute the query against solr and return the first returned object

Parameters:

query -

clazz -

method - must not be null.

Returns:

the first matching object

Since:

2.0

queryForPage

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

Execute the query against solr and retrun result as Page

Parameters:

query -

clazz -

Returns:

queryForPage

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

Execute the query against solr and retrun result as Page

Parameters:

query - must not be null.

clazz - must not be null.

method - must not be null.

Returns:

Since:

2.0

queryForFacetPage

<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

Parameters:

query -

clazz -

Returns:

queryForFacetPage

<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

Parameters:

query -

clazz -

method - must not be null.

Returns:

Since:

2.0

queryForHighlightPage

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

Execute a query and highlight matches in result

Parameters:

query -

clazz -

Returns:

queryForHighlightPage

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

Execute a query and highlight matches in result

Parameters:

query -

clazz -

method - must not be null.

Returns:

Since:

2.0

queryForTermsPage

TermsPage queryForTermsPage(TermsQuery query)

Execute query using terms handler

Parameters:

query -

Returns:

queryForTermsPage

TermsPage queryForTermsPage(TermsQuery query,
                            RequestMethod method)

Execute query using terms handler

Parameters:

query -

method - must not be null.

Returns:

Since:

2.0

queryForCursor

<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.

Parameters:

query -

clazz -

Returns:

Since:

1.3

queryForGroupPage

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

Execute the query against solr and return result as GroupPage

Parameters:

query -

clazz -

Returns:

Since:

1.4

queryForGroupPage

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

Execute the query against solr and return result as GroupPage

Parameters:

query -

clazz -

method - must not be null.

Returns:

Since:

2.0

queryForStatsPage

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

Execute the query against Solr and return result as StatsPage.

Parameters:

query - must not be null.

clazz - must not be null.

Returns:

queryForStatsPage

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

Execute the query against Solr and return result as StatsPage.

Parameters:

query - must not be null.

clazz - must not be null.

method - must not be null.

Returns:

Since:

2.0

getById

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

Executes a realtime get using given id.

Parameters:

id -

Returns:

Since:

1.4

getById

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

Executes a realtime get using given ids.

Parameters:

ids -

Returns:

Since:

1.4

commit

void commit()

Send commit command SolrClient.commit()

softCommit

void softCommit()

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

rollback

void rollback()

send rollback command SolrClient.rollback()

convertBeanToSolrInputDocument

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

Convert given bean into a solrj InputDocument

Parameters:

bean -

Returns:

getConverter

SolrConverter getConverter()

Returns:

Converter in use

execute

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

Execute action within callback

Parameters:

action -

Returns: