org.craftercms.search.service

Interface SearchService<T extends Query>

All Superinterfaces:

QueryFactory<T>

public interface SearchService<T extends Query>
extends QueryFactory<T>

Provides a basic interface to a search engine, like Solr.

Author:

Alfonso Vásquez, Dejan Brkic

Method Summary

Modifier and Type	Method and Description
void	commit() Commits any pending changes made to the search engine's default index.
void	commit(String indexId) Commits any pending changes made to the search engine's default index.
void	delete(String site, String id) Deletes the search engine's index data of an XML document.
void	delete(String indexId, String site, String id) Deletes the search engine's index data of an XML document.
Map<String,Object>	search(String indexId, T query) Does a full-text search and returns a Map model.
Map<String,Object>	search(T query) Does a full-text search and returns a Map model.
void	update(String site, String id, String xml, boolean ignoreRootInFieldNames) Updates the search engine's index data of an XML document.
void	update(String indexId, String site, String id, String xml, boolean ignoreRootInFieldNames) Updates the search engine's index data of an XML document.
void	updateContent(String site, String id, org.craftercms.core.service.Content content) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String site, String id, File file) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String site, String id, File file, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String indexId, String site, String id, File file) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
void	updateContent(String indexId, String site, String id, File file, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Methods inherited from interface org.craftercms.search.service.QueryFactory

createQuery, createQuery

Method Detail

search

Map<String,Object> search(T query)
                   throws SearchException

Does a full-text search and returns a Map model.

Parameters:

query - the query object

Returns:

search result in a Map data model. The key is the field name and the value is the field single value or multiple values (as a list)

Throws:

SearchException - if any error occurs that makes the search fail

search

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

Does a full-text search and returns a Map model.

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

query - the query object

Returns:

search result in a Map data model. The key is the field name and the value is the field single value or multiple values (as a list)

Throws:

SearchException - if any error occurs that makes the search fail

update

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

Updates the search engine's index data of an XML document.

Parameters:

site - the Crafter site name the content belongs to

id - the id of the XML document, within the site

xml - the XML document to update in the index

ignoreRootInFieldNames - ignore the root element of the input XML in field names

Throws:

SearchException

update

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

Updates the search engine's index data of an XML document.

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the XML document, within the site

xml - the XML document to update in the index

ignoreRootInFieldNames - ignore the root element of the input XML in field names

Throws:

SearchException

delete

void delete(String site,
            String id)
     throws SearchException

Deletes the search engine's index data of an XML document.

Parameters:

site - the Crafter site name the content belongs to

id - the id of the content, within the site

Throws:

SearchException

delete

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

Deletes the search engine's index data of an XML document.

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the content, within the site

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

site - the Crafter site name the content belongs to

id - the id of the file, within the site

file - the file content to update in the index

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the file, within the site

file - the file content to update in the index

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

site - the Crafter site name the content belongs to

id - the id of the file, within the site

file - the file content to update in the index

additionalFields - additional metadata fields to be indexed (shouldn't have the name site, id or document)

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the XML document, within the site

file - the file content to update in the index

additionalFields - additional metadata fields to be indexed (shouldn't have the name site, id or document)

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

site - the Crafter site name the content belongs to

id - the id of the file, within the site

content - the file content to update in the index

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the file, within the site

content - the file content to update in the index

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

site - the Crafter site name the content belongs to

id - the id of the file, within the site

content - the file content to update in the index

additionalFields - additional metadata fields to be indexed (shouldn't have the name site, id or document)

Throws:

SearchException

updateContent

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

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the XML document, within the site

content - the file content to update in the index

additionalFields - additional metadata fields to be indexed (shouldn't have the name site, id or document)

Throws:

SearchException

commit

void commit()
     throws SearchException

Commits any pending changes made to the search engine's default index.

Throws:

SearchException

commit

void commit(String indexId)
     throws SearchException

Commits any pending changes made to the search engine's default index.

Throws:

SearchException