org.craftercms.search.service.impl

Class SolrSearchService

java.lang.Object

org.craftercms.search.service.impl.SolrSearchService

All Implemented Interfaces:

QueryFactory<SolrQuery>, SearchService<SolrQuery>

public class SolrSearchService
extends Object
implements SearchService<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 String	defaultIndexId The ID of the default index.
protected Map<String,String>	deleteQueryMappings ID regex/delete query mappings that can be used to specify special delete queries for certain files, e.g.
static String	DOCUMENT_LIST_DOCUMENTS_PROPERTY_NAME
static String	DOCUMENT_LIST_MAX_SCORE_PROPERTY_NAME
static String	DOCUMENT_LIST_NUM_FOUND_PROPERTY_NAME
static String	DOCUMENT_LIST_START_PROPERTY_NAME
protected String	fileNameFieldName The file name field name (default is file-name).
protected FileTypeMap	mimeTypesMap Mime type map used to retrieve the mime types of files when submitting binary/structured content for indexing.
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.
static String	SOLR_CONTENT_STREAM_UPDATE_URL
protected org.apache.solr.client.solrj.SolrClient	solrClient The Solr client used to execute requests against a Solr server.
protected SolrDocumentBuilderImpl	solrDocumentBuilder The Solr document builder, to build Solr documents from generic XML documents.

Constructor Summary

Constructors

Constructor and Description
SolrSearchService()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalFilterQueries(String indexId, SolrQuery solrQuery)
void	commit()
void	commit(String indexId)
SolrQuery	createQuery()
SolrQuery	createQuery(Map<String,String[]> params)
void	delete(String site, String id)
void	delete(String indexId, String site, String id)
protected Collection<Map<String,Object>>	extractDocs(org.apache.solr.common.SolrDocumentList docList)
protected String	getDeleteQuery(String id)
protected String	getIndexPrefix(String indexId)
protected String	getSuccessfulMessage(String indexId, String idOrQuery, String operation, Object solrResponse)
Map<String,Object>	search(SolrQuery query)
Map<String,Object>	search(String indexId, SolrQuery query)
void	setAdditionalFilterQueries(String[] additionalFilterQueries) Sets the set of additional filter queries that should be used on all search requests
void	setDefaultIndexId(String defaultIndexId) Sets the ID of the default index.
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	setSolrClient(org.apache.solr.client.solrj.SolrClient solrClient) Sets the Solr client used to execute requests against a Solr server.
void	setSolrDocumentBuilder(SolrDocumentBuilderImpl solrDocumentBuilder) Sets the Solr document builder, to build Solr documents from generic XML documents.
protected org.apache.solr.common.params.SolrParams	toActualSolrQuery(QueryParams queryParams)
protected Map<String,Object>	toMap(org.apache.solr.common.util.NamedList<Object> namedList)
protected Object	toSerializableValue(Object namedListValue)
void	update(String site, String id, String xml, boolean ignoreRootInFieldNames)
void	update(String indexId, String site, String id, String xml, boolean ignoreRootInFieldNames)
void	updateContent(String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String site, String id, File file)
void	updateContent(String site, String id, File file, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, File file)
void	updateContent(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

SOLR_CONTENT_STREAM_UPDATE_URL

public static final String SOLR_CONTENT_STREAM_UPDATE_URL

See Also:

Constant Field Values

DOCUMENT_LIST_START_PROPERTY_NAME

public static final String DOCUMENT_LIST_START_PROPERTY_NAME

See Also:

Constant Field Values

DOCUMENT_LIST_NUM_FOUND_PROPERTY_NAME

public static final String DOCUMENT_LIST_NUM_FOUND_PROPERTY_NAME

See Also:

Constant Field Values

DOCUMENT_LIST_MAX_SCORE_PROPERTY_NAME

public static final String DOCUMENT_LIST_MAX_SCORE_PROPERTY_NAME

See Also:

Constant Field Values

DOCUMENT_LIST_DOCUMENTS_PROPERTY_NAME

public static final String DOCUMENT_LIST_DOCUMENTS_PROPERTY_NAME

See Also:

Constant Field Values

defaultIndexId

protected String defaultIndexId

The ID of the default index.

fileNameFieldName

protected String fileNameFieldName

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

solrClient

protected org.apache.solr.client.solrj.SolrClient solrClient

The Solr client used to execute requests against a Solr server.

solrDocumentBuilder

protected SolrDocumentBuilderImpl 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

mimeTypesMap

protected FileTypeMap mimeTypesMap

Mime type map used to retrieve the mime types of files when submitting binary/structured content for indexing.

Constructor Detail

SolrSearchService

public SolrSearchService()

Method Detail

setDefaultIndexId

public void setDefaultIndexId(String defaultIndexId)

Sets the ID of the default index.

setFileNameFieldName

public void setFileNameFieldName(String fileNameFieldName)

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

setSolrClient

public void setSolrClient(org.apache.solr.client.solrj.SolrClient solrClient)

Sets the Solr client used to execute requests against a Solr server.

setSolrDocumentBuilder

public void setSolrDocumentBuilder(SolrDocumentBuilderImpl 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(SolrQuery query)

Specified by:

search in interface SearchService<SolrQuery>

search

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

Specified by:

search in interface SearchService<SolrQuery>

Throws:

SearchException

update

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

Specified by:

update in interface SearchService<SolrQuery>

Throws:

SearchException

update

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

Specified by:

update in interface SearchService<SolrQuery>

Throws:

SearchException

delete

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

Specified by:

delete in interface SearchService<SolrQuery>

Throws:

SearchException

delete

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

Specified by:

delete in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String site,
                          String id,
                          File file)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

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

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

commit

public void commit()
            throws SearchException

Specified by:

commit in interface SearchService<SolrQuery>

Throws:

SearchException

commit

public void commit(String indexId)
            throws SearchException

Specified by:

commit in interface SearchService<SolrQuery>

Throws:

SearchException

toActualSolrQuery

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

toMap

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

toSerializableValue

protected Object toSerializableValue(Object namedListValue)

extractDocs

protected Collection<Map<String,Object>> extractDocs(org.apache.solr.common.SolrDocumentList docList)

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(String indexId,
                                          SolrQuery solrQuery)