org.craftercms.search.service

Interface ResourceAwareSearchService<T extends Query>

All Superinterfaces:

QueryFactory<T>, SearchService<T>

All Known Implementing Classes:

SolrRestClientSearchService, SolrRestClientSearchService

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

Extension of SearchService that provides methods for indexing binary/document files accessible through Spring Resources.

Author:

avasquez

Method Summary

Modifier and Type	Method and Description
default void	updateContent(String site, String id, org.springframework.core.io.Resource resource) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
default void	updateContent(String site, String id, org.springframework.core.io.Resource resource, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).
default void	updateContent(String indexId, String site, String id, org.springframework.core.io.Resource resource) 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.springframework.core.io.Resource resource, 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.SearchService

commit, commit, delete, delete, search, search, update, update, updateContent, updateContent, updateContent, updateContent, updateContent, updateContent, updateContent, updateContent

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

createQuery, createQuery

Method Detail

updateContent

default void updateContent(String site,
                           String id,
                           org.springframework.core.io.Resource resource)
                    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

resource - the file content to update in the index

Throws:

SearchException

updateContent

default void updateContent(String indexId,
                           String site,
                           String id,
                           org.springframework.core.io.Resource resource)
                    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

resource - the file content to update in the index

Throws:

SearchException

updateContent

default void updateContent(String site,
                           String id,
                           org.springframework.core.io.Resource resource,
                           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

resource - 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.springframework.core.io.Resource resource,
                   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

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