Package lumis.portal.bigdata.spi

Interface IBigDataRepositorySPI

All Superinterfaces:

IBigDataIndexer, IBigDataRepository, IBigDataSearcher

All Known Implementing Classes:

ElasticsearchRepository

@StableMinor(version="17.0",
             sinceVersion="8.1")
public interface IBigDataRepositorySPI
extends IBigDataRepository

Big data repository service provider interface.

To implement a custom big data repository, this interface must be implemented.

The implementation of this interface must be thread-safe.

The lifecycle of a big data repository is:

• init(java.lang.String) method is called.
• Other operations may be called.
• destroy() method is called.

Since:

8.1.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy this repository and performs any required resource freeing.
java.util.Collection<java.lang.String>	findDocumentTypesMissingIndices()	Returns the missing indices that are supposed to exist due to existent document types.
java.util.Map<java.lang.String,? extends DocumentType>	getAllDocumentTypes()	Returns all document types, indexed by document type identifier.
java.util.Map<java.util.Locale,IFile>	getSynonymsFiles()	Return a map with all files that the portal need to create based the Locales of synonyms and Locales of portal.
void	init(java.lang.String repositoryId)	Initializes this repository using the given node as configuration.
void	reloadSynonyms()	Reloads the synonyms in this repository.

Methods inherited from interface lumis.portal.bigdata.IBigDataIndexer

addDocument, addOrUpdateDocument, deleteDocument, deleteDocumentsByFieldValue, deleteDocumentsByFieldValue, deleteDocumentsByQuery, updateDocumentsByQuerySync

Methods inherited from interface lumis.portal.bigdata.IBigDataRepository

addOrUpdateDocumentType, addOrUpdateDocumentType, deleteDocumentType, getDelegate, getDelegate, getDocumentType, getDocumentTypeField, readDocument, startBatch

Methods inherited from interface lumis.portal.bigdata.IBigDataSearcher

getAutoCompleteSuggestions, search, validate

Method Detail

init

void init(java.lang.String repositoryId)

Initializes this repository using the given node as configuration.

Parameters:

repositoryId - the repository identifier.

Since:

8.1.0

destroy

void destroy()

Destroy this repository and performs any required resource freeing.

Since:

8.1.0

reloadSynonyms

void reloadSynonyms()
             throws AccessDeniedException,
                    PortalException

Reloads the synonyms in this repository.

Throws:

PortalException - if some error occur.

AccessDeniedException - if user doesn't have the appropriate permission.

Since:

11.1.0

getSynonymsFiles

java.util.Map<java.util.Locale,IFile> getSynonymsFiles()

Return a map with all files that the portal need to create based the Locales of synonyms and Locales of portal.

Returns:

a map that key is Locale, and, value is your file.

Since:

11.1.0

getAllDocumentTypes

java.util.Map<java.lang.String,? extends DocumentType> getAllDocumentTypes()

Returns all document types, indexed by document type identifier.

Returns:

all document types, indexed by document type identifier.

Since:

12.5.0

findDocumentTypesMissingIndices

java.util.Collection<java.lang.String> findDocumentTypesMissingIndices()

Returns the missing indices that are supposed to exist due to existent document types.

Returns:

a collection with the missing indices name, or an empty collection if there is no index missing.

Since:

16.0.0