org.craftercms.search.service.impl

Class SolrSearchService

java.lang.Object

org.craftercms.search.service.impl.SolrSearchService

All Implemented Interfaces:

QueryFactory<SolrQuery>, SearchService

public class SolrSearchService
extends Object
implements SearchService, QueryFactory<SolrQuery>

Implementation of SearchService using Solr as the underlying search engine.

Author:

Michael Chen, Alfonso Vasquez, Dejan Brkic

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	additionalFilterQueries Set of additional filter queries that should be used on all search requests
static String	DEFAULT_FILE_NAME_FIELD_NAME
protected Map<String,String>	deleteQueryMappings ID regex/delete query mappings that can be used to specify special delete queries for certain files, e.g.
protected String	fileNameFieldName The file name field name (default is file-name).
protected String	multiValueIgnorePattern The regex pattern used to ignore those additional fields that shouldn't be parsed for multi value.
protected String	multiValueSeparator Multi value separator for additional fields of structured documents.
protected SolrDocumentBuilder	solrDocumentBuilder The Solr document builder, to build Solr documents from generic XML documents.
protected SolrServerFactory	solrServerFactory Factory that creates index specific SolrServers.

Constructor Summary

Constructors

Constructor and Description
SolrSearchService()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalFilterQueries(SolrQuery solrQuery)
String	commit()
String	commit(String indexId)
SolrQuery	createQuery()
SolrQuery	createQuery(Map<String,String[]> params)
String	delete(String site, String id)
String	delete(String indexId, String site, String id)
protected Map<String,List<String>>	getAdditionalFieldMapAsMultiValueMap(Map<String,String> originalMap)
protected String	getDeleteQuery(String id)
protected String	getIndexPrefix(String indexId)
protected org.apache.solr.client.solrj.SolrServer	getSolrServer(String indexId)
protected String	getSuccessfulMessage(String indexId, String idOrQuery, String operation, Object solrResponse)
Map<String,Object>	search(Query query)
Map<String,Object>	search(String indexId, Query query)
void	setAdditionalFilterQueries(String[] additionalFilterQueries) Sets the set of additional filter queries that should be used on all search requests
void	setDeleteQueryMappings(Map<String,String> deleteQueryMappings) Sets ID regex/delete query mappings that can be used to specify special delete queries for certain files, e.g.
void	setFileNameFieldName(String fileNameFieldName) Sets the file name field (default is file-name).
void	setMultiValueIgnorePattern(String multiValueIgnorePattern) Sets the regex pattern used to ignore those additional fields that shouldn't be parsed for multi value.
void	setMultiValueSeparator(String multiValueSeparator) Sets the multi value separator for additional fields of structured documents.
void	setSolrDocumentBuilder(SolrDocumentBuilder solrDocumentBuilder) Sets the Solr document builder, to build Solr documents from generic XML documents.
void	setSolrServerFactory(SolrServerFactory solrServerFactory) Sets the factory that creates index specific SolrServers.
protected Map<String,Object>	toMap(org.apache.solr.common.util.NamedList<Object> namedList)
protected Object	toSerializableValue(Object namedListValue)
protected org.apache.solr.common.params.SolrParams	toSolrQuery(QueryParams queryParams)
String	update(String site, String id, String xml, boolean ignoreRootInFieldNames)
String	update(String indexId, String site, String id, String xml, boolean ignoreRootInFieldNames)
String	updateDocument(String site, String id, File document) Deprecated.
String	updateDocument(String site, String id, File document, Map<String,String> additionalFields) Deprecated.
String	updateFile(String site, String id, org.craftercms.core.service.Content content)
String	updateFile(String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
String	updateFile(String site, String id, File file)
String	updateFile(String site, String id, File file, Map<String,List<String>> additionalFields)
String	updateFile(String indexId, String site, String id, org.craftercms.core.service.Content content)
String	updateFile(String indexId, String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
String	updateFile(String indexId, String site, String id, File file)
String	updateFile(String indexId, String site, String id, File file, Map<String,List<String>> additionalFields)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILE_NAME_FIELD_NAME

public static final String DEFAULT_FILE_NAME_FIELD_NAME

See Also:

Constant Field Values

fileNameFieldName

protected String fileNameFieldName

The file name field name (default is file-name).

solrServerFactory

protected SolrServerFactory solrServerFactory

Factory that creates index specific SolrServers.

solrDocumentBuilder

protected SolrDocumentBuilder solrDocumentBuilder

The Solr document builder, to build Solr documents from generic XML documents.

multiValueSeparator

protected String multiValueSeparator

Multi value separator for additional fields of structured documents.

multiValueIgnorePattern

protected String multiValueIgnorePattern

The regex pattern used to ignore those additional fields that shouldn't be parsed for multi value.

deleteQueryMappings

protected Map<String,String> deleteQueryMappings

ID regex/delete query mappings that can be used to specify special delete queries for certain files, e.g. delete XML documents with their sub-documents.

additionalFilterQueries

protected String[] additionalFilterQueries

Set of additional filter queries that should be used on all search requests

Constructor Detail

SolrSearchService

public SolrSearchService()

Method Detail

setFileNameFieldName

public void setFileNameFieldName(String fileNameFieldName)

Sets the file name field (default is file-name).

setSolrServerFactory

public void setSolrServerFactory(SolrServerFactory solrServerFactory)

Sets the factory that creates index specific SolrServers.

setSolrDocumentBuilder

public void setSolrDocumentBuilder(SolrDocumentBuilder solrDocumentBuilder)

Sets the Solr document builder, to build Solr documents from generic XML documents.

setMultiValueSeparator

public void setMultiValueSeparator(String multiValueSeparator)

Sets the multi value separator for additional fields of structured documents.

setMultiValueIgnorePattern

public void setMultiValueIgnorePattern(String multiValueIgnorePattern)

Sets the regex pattern used to ignore those additional fields that shouldn't be parsed for multi value.

setDeleteQueryMappings

public void setDeleteQueryMappings(Map<String,String> deleteQueryMappings)

Sets ID regex/delete query mappings that can be used to specify special delete queries for certain files, e.g. delete XML documents with their sub-documents.

setAdditionalFilterQueries

public void setAdditionalFilterQueries(String[] additionalFilterQueries)

Sets the set of additional filter queries that should be used on all search requests

createQuery

public SolrQuery createQuery()

Specified by:

createQuery in interface QueryFactory<SolrQuery>

createQuery

public SolrQuery createQuery(Map<String,String[]> params)

Specified by:

createQuery in interface QueryFactory<SolrQuery>

search

public Map<String,Object> search(Query query)

Specified by:

search in interface SearchService

search

public Map<String,Object> search(String indexId,
                                 Query query)
                          throws SearchException

Specified by:

search in interface SearchService

Throws:

SearchException

update

public String update(String site,
                     String id,
                     String xml,
                     boolean ignoreRootInFieldNames)
              throws SearchException

Specified by:

update in interface SearchService

Throws:

SearchException

update

public String update(String indexId,
                     String site,
                     String id,
                     String xml,
                     boolean ignoreRootInFieldNames)
              throws SearchException

Specified by:

update in interface SearchService

Throws:

SearchException

delete

public String delete(String site,
                     String id)
              throws SearchException

Specified by:

delete in interface SearchService

Throws:

SearchException

delete

public String delete(String indexId,
                     String site,
                     String id)
              throws SearchException

Specified by:

delete in interface SearchService

Throws:

SearchException

updateDocument

@Deprecated
public String updateDocument(String site,
                                         String id,
                                         File document)
                                  throws SearchException

Deprecated.

Specified by:

updateDocument in interface SearchService

Throws:

SearchException

updateDocument

@Deprecated
public String updateDocument(String site,
                                         String id,
                                         File document,
                                         Map<String,String> additionalFields)
                                  throws SearchException

Deprecated.

Specified by:

updateDocument in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String site,
                         String id,
                         File file)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String indexId,
                         String site,
                         String id,
                         File file)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String site,
                         String id,
                         File file,
                         Map<String,List<String>> additionalFields)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String indexId,
                         String site,
                         String id,
                         File file,
                         Map<String,List<String>> additionalFields)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String site,
                         String id,
                         org.craftercms.core.service.Content content)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String indexId,
                         String site,
                         String id,
                         org.craftercms.core.service.Content content)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String site,
                         String id,
                         org.craftercms.core.service.Content content,
                         Map<String,List<String>> additionalFields)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

updateFile

public String updateFile(String indexId,
                         String site,
                         String id,
                         org.craftercms.core.service.Content content,
                         Map<String,List<String>> additionalFields)
                  throws SearchException

Specified by:

updateFile in interface SearchService

Throws:

SearchException

commit

public String commit()
              throws SearchException

Specified by:

commit in interface SearchService

Throws:

SearchException

commit

public String commit(String indexId)
              throws SearchException

Specified by:

commit in interface SearchService

Throws:

SearchException

toSolrQuery

protected org.apache.solr.common.params.SolrParams toSolrQuery(QueryParams queryParams)

toMap

protected Map<String,Object> toMap(org.apache.solr.common.util.NamedList<Object> namedList)

toSerializableValue

protected Object toSerializableValue(Object namedListValue)

getAdditionalFieldMapAsMultiValueMap

protected Map<String,List<String>> getAdditionalFieldMapAsMultiValueMap(Map<String,String> originalMap)

getSolrServer

protected org.apache.solr.client.solrj.SolrServer getSolrServer(String indexId)

getSuccessfulMessage

protected String getSuccessfulMessage(String indexId,
                                      String idOrQuery,
                                      String operation,
                                      Object solrResponse)

getIndexPrefix

protected String getIndexPrefix(String indexId)

getDeleteQuery

protected String getDeleteQuery(String id)

addAdditionalFilterQueries

protected void addAdditionalFilterQueries(SolrQuery solrQuery)