org.exoplatform.commons.search.es

Class ElasticSearchServiceConnector

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.search.SearchServiceConnector

org.exoplatform.commons.search.es.ElasticSearchServiceConnector

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class ElasticSearchServiceConnector
extends org.exoplatform.commons.api.search.SearchServiceConnector

Created by The eXo Platform SAS Author : Thibault Clement tclement@exoplatform.com 7/30/15

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHLIGHT_FRAGMENT_NUMBER_DEFAULT_VALUE
static String	HIGHLIGHT_FRAGMENT_NUMBER_PARAM_NAME
static int	HIGHLIGHT_FRAGMENT_SIZE_DEFAULT_VALUE
static String	HIGHLIGHT_FRAGMENT_SIZE_PARAM_NAME
int	highlightFragmentNumber
int	highlightFragmentSize

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
ElasticSearchServiceConnector(org.exoplatform.container.xml.InitParams initParams, ElasticSearchingClient client)

Method Summary

Modifier and Type	Method and Description
protected String	buildDetail(org.json.simple.JSONObject jsonHit, org.exoplatform.commons.api.search.data.SearchContext searchContext)
protected String	buildFilteredQuery(String query, Collection<String> sites, List<ElasticSearchFilter> filters, int offset, int limit, String sort, String order)
protected org.exoplatform.commons.api.search.data.SearchResult	buildHit(org.json.simple.JSONObject jsonHit, org.exoplatform.commons.api.search.data.SearchContext searchContext)
protected String	buildQuery(String query, Collection<String> sites, int offset, int limit, String sort, String order)
protected Collection<org.exoplatform.commons.api.search.data.SearchResult>	buildResult(String jsonResponse, org.exoplatform.commons.api.search.data.SearchContext context)
protected String	escapeReservedCharacters(String query) Escaped reserved characters by ES when using query_string.
Collection<org.exoplatform.commons.api.search.data.SearchResult>	filteredSearch(org.exoplatform.commons.api.search.data.SearchContext context, String query, List<ElasticSearchFilter> filters, Collection<String> sites, int offset, int limit, String sort, String order) Search on ES with additional filter on the search query Different Filter are: - Term Filter (Check if a specific term of a field exist) - Not exist Filter (Check if a term not exist) - Exist Filter (check if a term exist)
protected String	getAdditionalFilters(List<ElasticSearchFilter> filters)
ElasticSearchingClient	getClient()
protected String	getFields()
String	getImg()
String	getIndex()
protected String	getPermissionFilter()
List<String>	getSearchFields()
protected String	getSitesFilter(Collection<String> sitesCollection)
protected String	getSourceFields()
String	getTitleElasticFieldName()
protected String	getTitleFromJsonResult(org.json.simple.JSONObject hitSource)
String	getType()
protected Long	getUpdatedDateFromResult(org.json.simple.JSONObject hitSource)
protected String	getUrlFromJsonResult(org.json.simple.JSONObject hitSource, org.exoplatform.commons.api.search.data.SearchContext context)
Collection<org.exoplatform.commons.api.search.data.SearchResult>	search(org.exoplatform.commons.api.search.data.SearchContext context, String query, Collection<String> sites, int offset, int limit, String sort, String order)
void	setImg(String img)
void	setIndex(String index)
void	setSearchFields(List<String> searchFields)
void	setTitleElasticFieldName(String titleElasticFieldName)
void	setType(String type)

Methods inherited from class org.exoplatform.commons.api.search.SearchServiceConnector

getDisplayName, getSearchType, isEnable, isEnabledForAnonymous, setDisplayName, setEnable, setEnabledForAnonymous, setSearchType

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

HIGHLIGHT_FRAGMENT_SIZE_PARAM_NAME

public static final String HIGHLIGHT_FRAGMENT_SIZE_PARAM_NAME

See Also:

Constant Field Values

HIGHLIGHT_FRAGMENT_SIZE_DEFAULT_VALUE

public static final int HIGHLIGHT_FRAGMENT_SIZE_DEFAULT_VALUE

See Also:

Constant Field Values

HIGHLIGHT_FRAGMENT_NUMBER_PARAM_NAME

public static final String HIGHLIGHT_FRAGMENT_NUMBER_PARAM_NAME

See Also:

Constant Field Values

HIGHLIGHT_FRAGMENT_NUMBER_DEFAULT_VALUE

public static final int HIGHLIGHT_FRAGMENT_NUMBER_DEFAULT_VALUE

See Also:

Constant Field Values

highlightFragmentSize

public int highlightFragmentSize

highlightFragmentNumber

public int highlightFragmentNumber

Constructor Detail

ElasticSearchServiceConnector

public ElasticSearchServiceConnector(org.exoplatform.container.xml.InitParams initParams,
                                     ElasticSearchingClient client)

Method Detail

search

public Collection<org.exoplatform.commons.api.search.data.SearchResult> search(org.exoplatform.commons.api.search.data.SearchContext context,
                                                                               String query,
                                                                               Collection<String> sites,
                                                                               int offset,
                                                                               int limit,
                                                                               String sort,
                                                                               String order)

Specified by:

search in class org.exoplatform.commons.api.search.SearchServiceConnector

filteredSearch

public Collection<org.exoplatform.commons.api.search.data.SearchResult> filteredSearch(org.exoplatform.commons.api.search.data.SearchContext context,
                                                                                       String query,
                                                                                       List<ElasticSearchFilter> filters,
                                                                                       Collection<String> sites,
                                                                                       int offset,
                                                                                       int limit,
                                                                                       String sort,
                                                                                       String order)

Search on ES with additional filter on the search query Different Filter are: - Term Filter (Check if a specific term of a field exist) - Not exist Filter (Check if a term not exist) - Exist Filter (check if a term exist)

Parameters:

context -

query -

filters -

sites -

offset -

limit -

sort -

order -

Returns:

a collection of SearchResult

buildQuery

protected String buildQuery(String query,
                            Collection<String> sites,
                            int offset,
                            int limit,
                            String sort,
                            String order)

buildFilteredQuery

protected String buildFilteredQuery(String query,
                                    Collection<String> sites,
                                    List<ElasticSearchFilter> filters,
                                    int offset,
                                    int limit,
                                    String sort,
                                    String order)

escapeReservedCharacters

protected String escapeReservedCharacters(String query)

Escaped reserved characters by ES when using query_string. Only ~ is not escaped since it is used for fuzzy search parameter. The list of reserved characters is documented at https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters

Parameters:

query - The unescaped query string

Returns:

The escaped query string

buildResult

protected Collection<org.exoplatform.commons.api.search.data.SearchResult> buildResult(String jsonResponse,
                                                                                       org.exoplatform.commons.api.search.data.SearchContext context)

buildHit

protected org.exoplatform.commons.api.search.data.SearchResult buildHit(org.json.simple.JSONObject jsonHit,
                                                                        org.exoplatform.commons.api.search.data.SearchContext searchContext)

buildDetail

protected String buildDetail(org.json.simple.JSONObject jsonHit,
                             org.exoplatform.commons.api.search.data.SearchContext searchContext)

getUpdatedDateFromResult

protected Long getUpdatedDateFromResult(org.json.simple.JSONObject hitSource)

getUrlFromJsonResult

protected String getUrlFromJsonResult(org.json.simple.JSONObject hitSource,
                                      org.exoplatform.commons.api.search.data.SearchContext context)

getTitleFromJsonResult

protected String getTitleFromJsonResult(org.json.simple.JSONObject hitSource)

getAdditionalFilters

protected String getAdditionalFilters(List<ElasticSearchFilter> filters)

getFields

protected String getFields()

getPermissionFilter

protected String getPermissionFilter()

getSitesFilter

protected String getSitesFilter(Collection<String> sitesCollection)

getSourceFields

protected String getSourceFields()

getIndex

public String getIndex()

setIndex

public void setIndex(String index)

getImg

public String getImg()

setImg

public void setImg(String img)

getTitleElasticFieldName

public String getTitleElasticFieldName()

setTitleElasticFieldName

public void setTitleElasticFieldName(String titleElasticFieldName)

getSearchFields

public List<String> getSearchFields()

setSearchFields

public void setSearchFields(List<String> searchFields)

getType

public String getType()

setType

public void setType(String type)

getClient

public ElasticSearchingClient getClient()