es.prodevelop.pui9.elasticsearch.services

Class PuiElasticSearchIndexService

java.lang.Object

es.prodevelop.pui9.elasticsearch.services.AbstractPuiElasticSearchService

es.prodevelop.pui9.elasticsearch.services.PuiElasticSearchIndexService

All Implemented Interfaces:

IPuiElasticSearchIndexService

@Component
public class PuiElasticSearchIndexService
extends AbstractPuiElasticSearchService
implements IPuiElasticSearchIndexService

Implementation for the API to manage Indexes for ElasticSaerch

Author:

Marc Gil - mgil@prodevelop.es

Field Summary

Fields inherited from class es.prodevelop.pui9.elasticsearch.services.AbstractPuiElasticSearchService

daoRegistry, logger, puiElasticSearchEnablement, STRING_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PuiElasticSearchIndexService()

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 index prefix for the indexes of ElasticSearch for this application

Methods inherited from class es.prodevelop.pui9.elasticsearch.services.AbstractPuiElasticSearchService

getClient, getIndexesForDto, getIndexForLanguage, getLanguageFromIndex, isTextTerm

Methods inherited from class java.lang.Object

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

Constructor Detail

PuiElasticSearchIndexService

public PuiElasticSearchIndexService()

Method Detail

getIndexPrefix

public String getIndexPrefix()

Description copied from class: AbstractPuiElasticSearchService

Get the index prefix for the indexes of ElasticSearch for this application

Specified by:

getIndexPrefix in interface IPuiElasticSearchIndexService

Overrides:

getIndexPrefix in class AbstractPuiElasticSearchService

Returns:

The prefix for the indexes

createIndex

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

createIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

createIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

checkIndexMapping in interface IPuiElasticSearchIndexService

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

public void deleteIndex(String index)
                 throws PuiElasticSearchNoNodesException,
                        PuiElasticSearchDeleteIndexException

Description copied from interface: IPuiElasticSearchIndexService

Delete the given index

Specified by:

deleteIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

deleteIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

deleteIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

existsIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

existsIndex in interface IPuiElasticSearchIndexService

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

public List<String> getAllIndexes()
                           throws PuiElasticSearchNoNodesException

Description copied from interface: IPuiElasticSearchIndexService

Get the list of existing indexes names

Specified by:

getAllIndexes in interface IPuiElasticSearchIndexService

Returns:

The list of existing indexes names

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

countIndex

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

countIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

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

Specified by:

countIndex in interface IPuiElasticSearchIndexService

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

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

Description copied from interface: IPuiElasticSearchIndexService

Get the number of registries for the given indexex

Specified by:

countIndex in interface IPuiElasticSearchIndexService

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