es.prodevelop.pui9.elasticsearch.services

Class AbstractPuiElasticSearchService

java.lang.Object

es.prodevelop.pui9.elasticsearch.services.AbstractPuiElasticSearchService

Direct Known Subclasses:

PuiElasticSearchDocumentService, PuiElasticSearchIndexService, PuiElasticSearchSearchingService

public abstract class AbstractPuiElasticSearchService
extends Object

Provides common methods that can be used in the concrete services of ElasticSearch

Author:

Marc Gil - mgil@prodevelop.es

Field Summary

Fields

Modifier and Type	Field and Description
protected es.prodevelop.pui9.model.dao.registry.DaoRegistry	daoRegistry
protected org.apache.commons.logging.Log	logger
protected IPuiElasticSearchEnablement	puiElasticSearchEnablement
protected static String	STRING_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractPuiElasticSearchService()

Method Summary

Modifier and Type	Method and Description
protected org.elasticsearch.client.RestHighLevelClient	getClient() Get the ElasticSearch transport client object
protected List<String>	getIndexesForDto(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass) Return the list of indexes for the given Dto.
protected String	getIndexForLanguage(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, PuiLanguage language) Get the index for the given IViewDto class and language
protected String	getIndexPrefix() Get the index prefix for the indexes of ElasticSearch for this application
protected PuiLanguage	getLanguageFromIndex(String index) Get the language for the given Index
protected boolean	isTextTerm(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, String fieldName) Check if the given field is considered as Term for the given DTO class

Methods inherited from class java.lang.Object

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

Field Detail

STRING_SEPARATOR

protected static final String STRING_SEPARATOR

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

daoRegistry

@Autowired
protected es.prodevelop.pui9.model.dao.registry.DaoRegistry daoRegistry

puiElasticSearchEnablement

@Autowired
protected IPuiElasticSearchEnablement puiElasticSearchEnablement

Constructor Detail

AbstractPuiElasticSearchService

public AbstractPuiElasticSearchService()

Method Detail

getClient

protected org.elasticsearch.client.RestHighLevelClient getClient()
                                                          throws PuiElasticSearchNoNodesException

Get the ElasticSearch transport client object

Returns:

The ElasticSerch transport client object

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

getIndexesForDto

protected List<String> getIndexesForDto(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass)

Return the list of indexes for the given Dto.

• If the Dto has language support:
• If no language is specified: returns all the indexes for each existing language
• If a language is specified: it returns only this index
• If Dto has no language support: it returns the only existing index for it

Parameters:

dtoClass - The IViewDto class that represents the index

Returns:

The list of indexes of the given DTO class

getIndexForLanguage

protected String getIndexForLanguage(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                                     PuiLanguage language)

Get the index for the given IViewDto class and language

Parameters:

dtoClass - The IViewDto class that represents the index

language - The desired language

Returns:

The index for given DTO class and language

getIndexPrefix

protected String getIndexPrefix()

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

Returns:

The prefix for the indexes

getLanguageFromIndex

protected PuiLanguage getLanguageFromIndex(String index)

Get the language for the given Index

Parameters:

index - The index name

Returns:

The language of the index

isTextTerm

protected boolean isTextTerm(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                             String fieldName)

Check if the given field is considered as Term for the given DTO class

Parameters:

dtoClass - The DTO class of the field

fieldName - The field to check

Returns:

true if it's a text term; false if not