lumis.portal.bigdata.elasticsearch

Class ElasticsearchRepository

java.lang.Object

lumis.portal.bigdata.elasticsearch.ElasticsearchRepository

All Implemented Interfaces:

IBigDataIndexer, IBigDataRepository, IBigDataSearcher, IBigDataRepositorySPI

public class ElasticsearchRepository
extends Object
implements IBigDataRepositorySPI

Big data repository implementation that uses Elasticsearch.

Since:

8.1.0

Version:

$Revision: 19586 $ $Date: 2016-12-07 19:34:58 +0000 (Wed, 07 Dec 2016) $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.elasticsearch.action.bulk.BulkProcessor	bulkProcessor The BulkProcessor instance shared with IBatchIndexer generated by this repository.
protected org.elasticsearch.client.Client	client
protected ElasticsearchRepository	repository

Constructor Summary

Constructors

Constructor and Description
ElasticsearchRepository()

Method Summary

Modifier and Type	Method and Description
void	addDocument(Document document) Adds a content to the index.
void	addIndex(Locale locale) Adds the indices relative to the given locale in Elasticsearch.
void	addOrUpdateDocumentType(DocumentType documentType) Adds or updates a document type into managed indices.
void	deleteDocumentsByFieldValue(String fieldId, Collection<?> values) Deletes contents that are matched by one of the given values in the field of given field identifier.
void	deleteDocumentsByFieldValue(String fieldId, Object... values) Deletes contents that are matched by one of the given values in the field of given field identifier.
void	deleteDocumentsByQuery(SearchQuery searchQuery) Deletes contents that are matched by the given search query. The search query's sorts, initial hit and maximum hit count will be ignored.
void	deleteDocumentType(String documentTypeId) Deletes a given document type from managed indices.
void	deleteIndex(Locale locale) Deletes the indices related to the given locale.
void	destroy() Destroy this repository and performs any required resource freeing.
protected void	executeAsync(org.elasticsearch.action.ActionRequest request) Sends a request to Elasticsearch to be executed asynchronously.
protected <T extends org.elasticsearch.action.ActionResponse> T	executeSync(org.elasticsearch.action.ActionRequestBuilder<?,T,?> request) Executes a request to Elasticsearch synchronously and returns the response.
protected <T extends org.elasticsearch.action.ActionResponse> T	executeSync(org.elasticsearch.action.ActionRequestBuilder<?,T,?> request, boolean remapException) Executes a request to Elasticsearch synchronously and returns the response.
List<String>	getAutoCompleteSuggestions(SearchQuery searchQuery, AutoCompleteSuggestionConfig autoCompleteSuggestion) Returns a list of auto complete suggestions for the given auto complete suggestion configuration and the search query.
org.elasticsearch.client.Client	getDelegate() Returns the underlying Elasticsearch client of this repository.
DocumentType	getDocumentType(String documentTypeId) Returns the document type of the given identifier.
DocumentTypeField	getDocumentTypeField(String documentTypeFieldFullId) Return the document type field of the field that has the given identifier.
protected org.elasticsearch.action.search.SearchRequestBuilder	getQuery(SearchQuery searchQuery) Returns a search request builder based on the given SearchQuery.
String	getSearchAliasName() Returns the alias used for searching in lumis portal indices.
void	init(String repositoryId) Initializes this repository using the given node as configuration.
protected void	logRequest(Object request) Logs at debug level a request that will be sent to Elasticsearch.
ISearchResults	search(SearchQuery searchQuery) Runs the given search query and returns the search results.
IBatchIndexer	startBatch() Returns an indexer to perform bulk actions. The caller must assure IBatchIndexer.close() is called after the desired bulk operations were performed.
void	validate(SearchQuery searchQuery) Checks is the given search query is syntactically correct.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.bigdata.IBigDataIndexer

addDocument, deleteDocumentsByFieldValue, deleteDocumentsByFieldValue

Field Detail

client

protected org.elasticsearch.client.Client client

bulkProcessor

protected org.elasticsearch.action.bulk.BulkProcessor bulkProcessor

The BulkProcessor instance shared with IBatchIndexer generated by this repository.

Since:

8.1.0

See Also:

startBatch()

repository

protected ElasticsearchRepository repository

Constructor Detail

ElasticsearchRepository

public ElasticsearchRepository()

Method Detail

init

public void init(String repositoryId)

Description copied from interface: IBigDataRepositorySPI

Initializes this repository using the given node as configuration.

Specified by:

init in interface IBigDataRepositorySPI

Parameters:

repositoryId - the repository identifier.

getSearchAliasName

public String getSearchAliasName()

Returns the alias used for searching in lumis portal indices.

Returns:

the alias.

Since:

8.2.1

addIndex

public void addIndex(Locale locale)

Adds the indices relative to the given locale in Elasticsearch.

Parameters:

locale - the locale the indices to be created refers to.

Since:

8.1.0

deleteIndex

public void deleteIndex(Locale locale)

Deletes the indices related to the given locale.

Parameters:

locale - the locale.

Since:

8.1.0

destroy

public void destroy()

Description copied from interface: IBigDataRepositorySPI

Destroy this repository and performs any required resource freeing.

Specified by:

destroy in interface IBigDataRepositorySPI

addOrUpdateDocumentType

public void addOrUpdateDocumentType(DocumentType documentType)

Description copied from interface: IBigDataRepository

Adds or updates a document type into managed indices.

Specified by:

addOrUpdateDocumentType in interface IBigDataRepository

Parameters:

documentType - the document type to be added.

See Also:

DocumentTypes

deleteDocumentType

public void deleteDocumentType(String documentTypeId)
                        throws PortalObjectNotFoundException

Description copied from interface: IBigDataRepository

Deletes a given document type from managed indices.

Specified by:

deleteDocumentType in interface IBigDataRepository

Parameters:

documentTypeId - the document type identifier to be deleted.

Throws:

PortalObjectNotFoundException - if the document type with the given identifier couldn't be found.

getDocumentType

public DocumentType getDocumentType(String documentTypeId)
                             throws PortalObjectNotFoundException

Description copied from interface: IBigDataRepository

Returns the document type of the given identifier.

Specified by:

getDocumentType in interface IBigDataRepository

Parameters:

documentTypeId - the document type identifier.

Returns:

the document type of the given identifier.

Throws:

PortalObjectNotFoundException - if the desired type does not exist.

getDocumentTypeField

public DocumentTypeField getDocumentTypeField(String documentTypeFieldFullId)
                                       throws PortalObjectNotFoundException

Description copied from interface: IBigDataRepository

Return the document type field of the field that has the given identifier.

Specified by:

getDocumentTypeField in interface IBigDataRepository

Parameters:

documentTypeFieldFullId - the (full) identifier of the document type field.

Returns:

the document type field of the field that has the given identifier.

Throws:

PortalObjectNotFoundException - if the desired field does not exist.

startBatch

public IBatchIndexer startBatch()

Description copied from interface: IBigDataRepository

Returns an indexer to perform bulk actions.
The caller must assure IBatchIndexer.close() is called after the desired bulk operations were performed.

Example of usage:

IBatchIndexer batchIndexer = myBigDataRepository.startBatch(); try { // batch operations here } finally { batchIndexer.close(); }
Or using try-with-resources:
try(IBatchIndexer batchIndexer = myBigDataRepository.startBatch()) { // batch operations here }

Specified by:

startBatch in interface IBigDataRepository

Returns:

an indexer to perform bulk actions.

deleteDocumentsByQuery

public void deleteDocumentsByQuery(SearchQuery searchQuery)

Description copied from interface: IBigDataIndexer

Deletes contents that are matched by the given search query.
The search query's sorts, initial hit and maximum hit count will be ignored.

Specified by:

deleteDocumentsByQuery in interface IBigDataIndexer

Parameters:

searchQuery - the search query.

search

public ISearchResults search(SearchQuery searchQuery)

Description copied from interface: IBigDataSearcher

Runs the given search query and returns the search results.

Specified by:

search in interface IBigDataSearcher

Parameters:

searchQuery - the query to run.

Returns:

the search results.

getAutoCompleteSuggestions

public List<String> getAutoCompleteSuggestions(SearchQuery searchQuery,
                                               AutoCompleteSuggestionConfig autoCompleteSuggestion)

Description copied from interface: IBigDataSearcher

Returns a list of auto complete suggestions for the given auto complete suggestion configuration and the search query.

Specified by:

getAutoCompleteSuggestions in interface IBigDataSearcher

Parameters:

searchQuery - the search query the auto complete request will be based on.

autoCompleteSuggestion - the auto complete suggestion request.

Returns:

a list of auto complete suggestions for the given auto complete suggestion request.

validate

public void validate(SearchQuery searchQuery)
              throws PortalException

Description copied from interface: IBigDataSearcher

Checks is the given search query is syntactically correct.

Specified by:

validate in interface IBigDataSearcher

Parameters:

searchQuery - the search query to be validated

Throws:

PortalException - if there is a syntax error in query.

getDelegate

public org.elasticsearch.client.Client getDelegate()

Returns the underlying Elasticsearch client of this repository.

Specified by:

getDelegate in interface IBigDataRepository

Returns:

the underlying Elasticsearch client of this repository.

addDocument

public void addDocument(Document document)

Description copied from interface: IBigDataIndexer

Adds a content to the index.

Specified by:

addDocument in interface IBigDataIndexer

Parameters:

document - the content to be added.

deleteDocumentsByFieldValue

public void deleteDocumentsByFieldValue(String fieldId,
                                        Object... values)

Description copied from interface: IBigDataIndexer

Deletes contents that are matched by one of the given values in the field of given field identifier.

Specified by:

deleteDocumentsByFieldValue in interface IBigDataIndexer

Parameters:

fieldId - the field identifier.

values - the values.

deleteDocumentsByFieldValue

public void deleteDocumentsByFieldValue(String fieldId,
                                        Collection<?> values)

Description copied from interface: IBigDataIndexer

Deletes contents that are matched by one of the given values in the field of given field identifier.

Specified by:

deleteDocumentsByFieldValue in interface IBigDataIndexer

Parameters:

fieldId - the field identifier.

values - the values.

getQuery

protected org.elasticsearch.action.search.SearchRequestBuilder getQuery(SearchQuery searchQuery)

Returns a search request builder based on the given SearchQuery.

Parameters:

searchQuery - the search query.

Returns:

a search request builder based on the given SearchQuery.

Since:

8.1.0

executeSync

protected <T extends org.elasticsearch.action.ActionResponse> T executeSync(org.elasticsearch.action.ActionRequestBuilder<?,T,?> request)

Executes a request to Elasticsearch synchronously and returns the response.

Since:

8.1.0

executeSync

protected <T extends org.elasticsearch.action.ActionResponse> T executeSync(org.elasticsearch.action.ActionRequestBuilder<?,T,?> request,
                                                                            boolean remapException)

Executes a request to Elasticsearch synchronously and returns the response.

Since:

8.1.0

executeAsync

protected void executeAsync(org.elasticsearch.action.ActionRequest request)

Sends a request to Elasticsearch to be executed asynchronously.

Since:

8.1.0

logRequest

protected void logRequest(Object request)

Logs at debug level a request that will be sent to Elasticsearch.

Parameters:

request - the request object.

Since:

8.1.0