es.prodevelop.pui9.elasticsearch.services.interfaces

Interface IPuiElasticSearchIndexService

All Known Implementing Classes:

PuiElasticSearchIndexService

public interface IPuiElasticSearchIndexService

API to manage the Indexes of ElaticSearch

Author:

Marc Gil - mgil@prodevelop.es

Method Summary

Modifier and Type	Method and Description
boolean	checkIndexMapping(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Check if the existing index of the given Dto has the same mapping than the Dto
long	countIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Get the number of indexed documents for the given View DTO Class
long	countIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, PuiLanguage language) Get the number of indexed documents for the given View DTO Class
Map<String,Long>	countIndex(List<String> indexes) Get the number of registries for the given indexex
void	createIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Create the indexes related with the view that is represented by the given View DTO Class
void	createIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, PuiLanguage language) Create the index related with the view that is represented by the given View DTO Class, for the given language
void	deleteIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Delete the indexes related with the view that is represented by the given View DTO Class
void	deleteIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, PuiLanguage language) Delete the index related with the view that is represented by the given View DTO Class, for the given language
void	deleteIndex(String index) Delete the given index
boolean	existsIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Check if the index that belongs to the given View DTO Class exists or not
boolean	existsIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, PuiLanguage language) Check if the index that belongs to the given View DTO Class exists or not, for the given language
List<String>	getAllIndexes() Get the list of existing indexes names
String	getIndexPrefix() Get the prefix for the indexes

Method Detail

getIndexPrefix

String getIndexPrefix()

Get the prefix for the indexes

Returns:

The index prefix

createIndex

void createIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)
          throws PuiElasticSearchNoNodesException,
                 PuiElasticSearchCreateIndexException

Create the indexes related with the view that is represented by the given View DTO Class

Parameters:

dtoClass - The View DTO Class that represents the View

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchCreateIndexException - If any error occurs while creating the Index

createIndex

void createIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                 PuiLanguage language)
          throws PuiElasticSearchNoNodesException,
                 PuiElasticSearchCreateIndexException

Create the index related with the view that is represented by the given View DTO Class, for the given language

Parameters:

dtoClass - The View DTO Class that represents the View

language - The language that represents the index to be created. May be null, in that case an index for each existing language will be created

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchCreateIndexException - If any error occurs while creating the Index

checkIndexMapping

boolean checkIndexMapping(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)
                   throws PuiElasticSearchNoNodesException

Check if the existing index of the given Dto has the same mapping than the Dto

Parameters:

dtoClass - The View DTO Class that represents the view

Returns:

True if the index is valid; False if not

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

deleteIndex

void deleteIndex(String index)
          throws PuiElasticSearchNoNodesException,
                 PuiElasticSearchDeleteIndexException

Delete the given index

Parameters:

index - The Index to be deleted

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchDeleteIndexException - If any error occurs while deleting the Index

deleteIndex

void deleteIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)
          throws PuiElasticSearchNoNodesException,
                 PuiElasticSearchDeleteIndexException

Delete the indexes related with the view that is represented by the given View DTO Class

Parameters:

dtoClass - The View DTO Class that represents the View

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchDeleteIndexException - If any error occurs while deleting the Index

deleteIndex

void deleteIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                 PuiLanguage language)
          throws PuiElasticSearchNoNodesException,
                 PuiElasticSearchDeleteIndexException

Delete the index related with the view that is represented by the given View DTO Class, for the given language

Parameters:

dtoClass - The View DTO Class that represents the View

language - The language that represents the index to be deleted. May be null, in that case an index for each existing language will be deleted

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchDeleteIndexException - If any error occurs while creating the Index

existsIndex

boolean existsIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)
             throws PuiElasticSearchNoNodesException,
                    PuiElasticSearchExistsIndexException

Check if the index that belongs to the given View DTO Class exists or not

Parameters:

dtoClass - The View DTO Class that represents the View

Returns:

true if the index exists, false if not

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchExistsIndexException - If there is a index lack of a translated View

existsIndex

boolean existsIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                    PuiLanguage language)
             throws PuiElasticSearchNoNodesException,
                    PuiElasticSearchExistsIndexException

Check if the index that belongs to the given View DTO Class exists or not, for the given language

Parameters:

dtoClass - The View DTO Class that represents the View

language - The language that represents the index to be checked. May be null, in that case an index for each existing language will be checked

Returns:

true if the index exists, false if not

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchExistsIndexException - If the number of existing indexes and the number of indexes that should exists is not equal

getAllIndexes

List<String> getAllIndexes()
                    throws PuiElasticSearchNoNodesException

Get the list of existing indexes names

Returns:

The list of existing indexes names

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

countIndex

long countIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)
         throws PuiElasticSearchNoNodesException,
                PuiElasticSearchCountException

Get the number of indexed documents for the given View DTO Class

Parameters:

dtoClass - The View DTO Class that represents the View

Returns:

The number of indexed documents

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchCountException - If multiple indexes (languages) are checked and the value is distinct for each one

countIndex

long countIndex(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                PuiLanguage language)
         throws PuiElasticSearchNoNodesException,
                PuiElasticSearchCountException

Get the number of indexed documents for the given View DTO Class

Parameters:

dtoClass - The View DTO Class that represents the View

language - The language that represents the index to be checked. May be null, in that case an index for each existing language will be checked

Returns:

The number of indexed documents

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchCountException - If multiple indexes (languages) are checked and the value is distinct for each one

countIndex

Map<String,Long> countIndex(List<String> indexes)
                     throws PuiElasticSearchNoNodesException

Get the number of registries for the given indexex

Parameters:

indexes - The list of the indexes to retrieve the count

Returns:

The number of registries for each index

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node