org.craftercms.search.elasticsearch

Interface ElasticsearchService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ElasticsearchServiceImpl, MultiElasticsearchServiceImpl

public interface ElasticsearchService
extends AutoCloseable

Provides access to indexing operations in Elasticsearch

Author:

joseross

Method Summary

Modifier and Type	Method and Description
void	delete(String indexName, String siteId, String docId) Performs a delete for the given document
void	index(String indexName, String siteId, String docId, Map<String,Object> doc)
default void	index(String indexName, String siteId, String docId, String xml) Performs an index for the given xml file
void	index(String indexName, String siteId, String docId, String xml, Map<String,Object> additionalFields) Performs an index for the given xml file
void	indexBinary(String indexName, String siteName, String path, Map<String,Object> additionalFields, org.craftercms.core.service.Content content) Performs an index for the given binary file
void	indexBinary(String indexName, String siteName, String path, Map<String,Object> additionalFields, org.springframework.core.io.Resource resource)
void	refresh(String indexName) Performs a refresh for a given index
List<String>	searchField(String indexName, String field, org.elasticsearch.index.query.QueryBuilder queryBuilder) Performs a search for a specific field
Map<String,Object>	searchId(String indexName, String docId)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

searchField

List<String> searchField(String indexName,
                         String field,
                         org.elasticsearch.index.query.QueryBuilder queryBuilder)
                  throws ElasticsearchException

Performs a search for a specific field

Parameters:

indexName - the name of the index

field - the name of the field

queryBuilder - the filters to apply

Returns:

the list of values that match the search

Throws:

ElasticsearchException - if there is any error during the operation

searchId

Map<String,Object> searchId(String indexName,
                            String docId)

index

void index(String indexName,
           String siteId,
           String docId,
           Map<String,Object> doc)

index

default void index(String indexName,
                   String siteId,
                   String docId,
                   String xml)
            throws ElasticsearchException

Performs an index for the given xml file

Parameters:

indexName - the name of the index

siteId - the name of the site

docId - the id of the document

xml - the content of the document

Throws:

ElasticsearchException - if there is any error during the operation

index

void index(String indexName,
           String siteId,
           String docId,
           String xml,
           Map<String,Object> additionalFields)
    throws ElasticsearchException

Performs an index for the given xml file

Parameters:

indexName - the name of the index

siteId - the name of the site

docId - the id of the document

xml - the content of the document

additionalFields - additional fields to index

Throws:

ElasticsearchException - if there is any error during the operation

indexBinary

void indexBinary(String indexName,
                 String siteName,
                 String path,
                 Map<String,Object> additionalFields,
                 org.craftercms.core.service.Content content)
          throws ElasticsearchException

Performs an index for the given binary file

Parameters:

indexName - the name of the index

siteName - the name of the site

path - the path of the document

additionalFields - the additional fields to index

content - the content of the document

Throws:

ElasticsearchException - if there is any error during the operation

indexBinary

void indexBinary(String indexName,
                 String siteName,
                 String path,
                 Map<String,Object> additionalFields,
                 org.springframework.core.io.Resource resource)
          throws ElasticsearchException

Throws:

ElasticsearchException

delete

void delete(String indexName,
            String siteId,
            String docId)
     throws ElasticsearchException

Performs a delete for the given document

Parameters:

indexName - the name of the index

siteId - the id of the site

docId - the id of the document

Throws:

ElasticsearchException - if there is any error during the operation

refresh

void refresh(String indexName)
      throws ElasticsearchException

Performs a refresh for a given index

Parameters:

indexName - the name of the index

Throws:

ElasticsearchException - if there is any error during the operation