ElasticsearchHelper (herd docs javadoc 0.96.0 API)

java.lang.Object
- org.finra.herd.dao.helper.ElasticsearchHelper

@Component
public class ElasticsearchHelper
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BDEF_TAG_CODE_FIELD` The tag code field
`static String`	`BDEF_TAG_NAME_FIELD` The tag display name field
`static String`	`BDEF_TAGTYPE_CODE_FIELD` The tag type code field
`static String`	`BDEF_TAGTYPE_NAME_FIELD` The tag type display name field
`static String`	`DISPLAY_NAME_SOURCE` Source string for the display name
`static String`	`NESTED_BDEFTAGS_PATH` The nested path of business object definition tags
`static String`	`RESULT_TYPE_AGGS` The result type agg
`static String`	`RESULT_TYPE_FACET` the result type Facet
`static String`	`RESULT_TYPE_FIELD`
`static String`	`TAG_CODE_AGGREGATION` The user defined tag code sub aggregation name.
`static String`	`TAG_CODE_FIELD_TAG_INDEX` The tag code field from tag index
`static String`	`TAG_FACET` The tag Facet Field name
`static String`	`TAG_FACET_AGGS` The nested aggregation name for tag facet.
`static String`	`TAG_NAME_AGGREGATION` The user defined tag display name sub aggregation name.
`static String`	`TAG_NAME_FIELD_TAG_INDEX` The tag display name field from tag index
`static String`	`TAG_TAG_CODE_FIELD` The tagCode field
`static String`	`TAG_TAGTYPE_CODE_FIELD` The tag type code field
`static String`	`TAG_TYPE_FACET_AGGS` The user defined agg name for tag type facet.
`static String`	`TAGTYPE_CODE_AGGREGATION` The user defined tag type code sub aggregation name.
`static String`	`TAGTYPE_CODE_FIELD_TAG_INDEX` The tag type code field from tag index
`static String`	`TAGTYPE_NAME_AGGREGATION` The user defined tag type display name sub aggregation name.
`static String`	`TAGTYPE_NAME_FIELD_TAG_INDEX` The tag type display name field from tag index

Constructor Summary

Constructors
Constructor and Description

ElasticsearchHelper()

Constructors
Constructor and Description
`ElasticsearchHelper()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchRequestBuilder`	`addFacetFieldAggregations(Set<String> facetFieldsList, SearchRequestBuilder searchRequestBuilder)` Adds facet field aggregations
`BoolQueryBuilder`	`addIndexSearchFilterBooleanClause(List<IndexSearchFilter> indexSearchFilters, String bdefActiveIndex, String tagActiveIndex)` Navigates the specified index search filters and adds boolean filter clauses to a given `SearchRequestBuilder`
`Terms`	`getAggregation(SearchResponse searchResponse, String aggregationName)` Returns the aggregation that is associated with the specified name.
`protected Aggregations`	`getAggregationsFromNestedAggregation(Nested nestedAggregation, SearchResponse searchResponse)` Returns a representation of a set of aggregations from the nested aggregation.
`protected Aggregations`	`getAggregationsFromSearchResponse(SearchResponse searchResponse)` Returns a representation of a set of aggregations from the search response.
`List<Facet>`	`getFacetsResponse(ElasticsearchResponseDto elasticsearchResponseDto, String bdefActiveIndex, String tagActiveIndex)` get the facets in the response
`Terms`	`getNestedAggregation(SearchResponse searchResponse, String nestedAggregationName, String subAggregationName)` Returns the sub-aggregation that is associated with the specified nested aggregation.
`List<TagTypeIndexSearchResponseDto>`	`getNestedTagTagIndexSearchResponseDto(SearchResponse searchResponse)` create tag tag index response dto
`List<TagTypeIndexSearchResponseDto>`	`getNestedTagTagIndexSearchResponseDto(SearchResult searchResult)` create tag tag index response dto
`List<ResultTypeIndexSearchResponseDto>`	`getResultTypeIndexSearchResponseDto(SearchResponse searchResponse)` Creates result type facet response dto
`List<ResultTypeIndexSearchResponseDto>`	`getResultTypeIndexSearchResponseDto(SearchResult searchResult)` Creates result type facet response dto
`String`	`getSearchIndexType(String indexName, String bdefActiveIndex, String tagActiveIndex)` Return the relative search index type for the index name.
`List<TagTypeIndexSearchResponseDto>`	`getTagTagIndexSearchResponseDto(SearchResponse searchResponse)` get tag index search response dto
`List<TagTypeIndexSearchResponseDto>`	`getTagTagIndexSearchResponseDto(SearchResult searchResult)` get tag index search response dto

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DISPLAY_NAME_SOURCE
```
public static final String DISPLAY_NAME_SOURCE
```
    Source string for the display name
    
    See Also:
    
    Constant Field Values
  - NESTED_BDEFTAGS_PATH
```
public static final String NESTED_BDEFTAGS_PATH
```
    The nested path of business object definition tags
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_CODE_FIELD_TAG_INDEX
```
public static final String TAGTYPE_CODE_FIELD_TAG_INDEX
```
    The tag type code field from tag index
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_NAME_FIELD_TAG_INDEX
```
public static final String TAGTYPE_NAME_FIELD_TAG_INDEX
```
    The tag type display name field from tag index
    
    See Also:
    
    Constant Field Values
  - TAG_CODE_FIELD_TAG_INDEX
```
public static final String TAG_CODE_FIELD_TAG_INDEX
```
    The tag code field from tag index
    
    See Also:
    
    Constant Field Values
  - TAG_NAME_FIELD_TAG_INDEX
```
public static final String TAG_NAME_FIELD_TAG_INDEX
```
    The tag display name field from tag index
    
    See Also:
    
    Constant Field Values
  - BDEF_TAGTYPE_CODE_FIELD
```
public static final String BDEF_TAGTYPE_CODE_FIELD
```
    The tag type code field
    
    See Also:
    
    Constant Field Values
  - BDEF_TAGTYPE_NAME_FIELD
```
public static final String BDEF_TAGTYPE_NAME_FIELD
```
    The tag type display name field
    
    See Also:
    
    Constant Field Values
  - BDEF_TAG_CODE_FIELD
```
public static final String BDEF_TAG_CODE_FIELD
```
    The tag code field
    
    See Also:
    
    Constant Field Values
  - BDEF_TAG_NAME_FIELD
```
public static final String BDEF_TAG_NAME_FIELD
```
    The tag display name field
    
    See Also:
    
    Constant Field Values
  - TAG_TAG_CODE_FIELD
```
public static final String TAG_TAG_CODE_FIELD
```
    The tagCode field
    
    See Also:
    
    Constant Field Values
  - TAG_TAGTYPE_CODE_FIELD
```
public static final String TAG_TAGTYPE_CODE_FIELD
```
    The tag type code field
    
    See Also:
    
    Constant Field Values
  - TAG_FACET_AGGS
```
public static final String TAG_FACET_AGGS
```
    The nested aggregation name for tag facet. User defined.
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_CODE_AGGREGATION
```
public static final String TAGTYPE_CODE_AGGREGATION
```
    The user defined tag type code sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_NAME_AGGREGATION
```
public static final String TAGTYPE_NAME_AGGREGATION
```
    The user defined tag type display name sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_CODE_AGGREGATION
```
public static final String TAG_CODE_AGGREGATION
```
    The user defined tag code sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_NAME_AGGREGATION
```
public static final String TAG_NAME_AGGREGATION
```
    The user defined tag display name sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_FACET
```
public static final String TAG_FACET
```
    The tag Facet Field name
    
    See Also:
    
    Constant Field Values
  - RESULT_TYPE_FACET
```
public static final String RESULT_TYPE_FACET
```
    the result type Facet
    
    See Also:
    
    Constant Field Values
  - TAG_TYPE_FACET_AGGS
```
public static final String TAG_TYPE_FACET_AGGS
```
    The user defined agg name for tag type facet.
    
    See Also:
    
    Constant Field Values
  - RESULT_TYPE_AGGS
```
public static final String RESULT_TYPE_AGGS
```
    The result type agg
    
    See Also:
    
    Constant Field Values
  - RESULT_TYPE_FIELD
```
public static final String RESULT_TYPE_FIELD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ElasticsearchHelper
```
public ElasticsearchHelper()
```
- Method Detail
  - addFacetFieldAggregations
```
public SearchRequestBuilder addFacetFieldAggregations(Set<String> facetFieldsList,
                                                      SearchRequestBuilder searchRequestBuilder)
```
    Adds facet field aggregations
    
    Parameters:
    
    facetFieldsList - facet field list
    
    searchRequestBuilder - search request builder
    
    Returns:
    
    the specified search request builder with the aggregations applied to it
  - addIndexSearchFilterBooleanClause
```
public BoolQueryBuilder addIndexSearchFilterBooleanClause(List<IndexSearchFilter> indexSearchFilters,
                                                          String bdefActiveIndex,
                                                          String tagActiveIndex)
```
    Navigates the specified index search filters and adds boolean filter clauses to a given SearchRequestBuilder
    
    Parameters:
    
    indexSearchFilters - the specified search filters
    
    bdefActiveIndex - the active bdef index name
    
    tagActiveIndex - the active tag index name
    
    Returns:
    
    boolean query with the filters applied
  - getResultTypeIndexSearchResponseDto
```
public List<ResultTypeIndexSearchResponseDto> getResultTypeIndexSearchResponseDto(SearchResponse searchResponse)
```
    Creates result type facet response dto
    
    Parameters:
    
    searchResponse - search response
    
    Returns:
    
    result type facet response dto list
  - getResultTypeIndexSearchResponseDto
```
public List<ResultTypeIndexSearchResponseDto> getResultTypeIndexSearchResponseDto(SearchResult searchResult)
```
    Creates result type facet response dto
    
    Parameters:
    
    searchResult - search result
    
    Returns:
    
    result type facet response dto list
  - getTagTagIndexSearchResponseDto
```
public List<TagTypeIndexSearchResponseDto> getTagTagIndexSearchResponseDto(SearchResponse searchResponse)
```
    get tag index search response dto
    
    Parameters:
    
    searchResponse - elastic search response
    
    Returns:
    
    list of tag type index search response dto
  - getTagTagIndexSearchResponseDto
```
public List<TagTypeIndexSearchResponseDto> getTagTagIndexSearchResponseDto(SearchResult searchResult)
```
    get tag index search response dto
    
    Parameters:
    
    searchResult - elastic search result
    
    Returns:
    
    list of tag type index search response dto
  - getNestedTagTagIndexSearchResponseDto
```
public List<TagTypeIndexSearchResponseDto> getNestedTagTagIndexSearchResponseDto(SearchResponse searchResponse)
```
    create tag tag index response dto
    
    Parameters:
    
    searchResponse - search response
    
    Returns:
    
    tag type index search response dto list
  - getNestedTagTagIndexSearchResponseDto
```
public List<TagTypeIndexSearchResponseDto> getNestedTagTagIndexSearchResponseDto(SearchResult searchResult)
```
    create tag tag index response dto
    
    Parameters:
    
    searchResult - search result
    
    Returns:
    
    tag type index search response dto list
  - getFacetsResponse
```
public List<Facet> getFacetsResponse(ElasticsearchResponseDto elasticsearchResponseDto,
                                     String bdefActiveIndex,
                                     String tagActiveIndex)
```
    get the facets in the response
    
    Parameters:
    
    elasticsearchResponseDto - elastic search response dto
    
    bdefActiveIndex - the name of the active index for business object definitions
    
    tagActiveIndex - the name os the active index for tags
    
    Returns:
    
    facets in the response dto
  - getAggregation
```
public Terms getAggregation(SearchResponse searchResponse,
                            String aggregationName)
```
    Returns the aggregation that is associated with the specified name. This method also validates that the retrieved aggregation exists.
    
    Parameters:
    
    searchResponse - the response of the search request
    
    aggregationName - the name of the aggregation
    
    Returns:
    
    the aggregation
  - getNestedAggregation
```
public Terms getNestedAggregation(SearchResponse searchResponse,
                                  String nestedAggregationName,
                                  String subAggregationName)
```
    Returns the sub-aggregation that is associated with the specified nested aggregation. This method also validates that the retrieved sub-aggregation exists.
    
    Parameters:
    
    searchResponse - the response of the search request
    
    nestedAggregationName - the name of the nested aggregation
    
    subAggregationName - the name of the sub-aggregation
    
    Returns:
    
    the aggregation
  - getSearchIndexType
```
public String getSearchIndexType(String indexName,
                                 String bdefActiveIndex,
                                 String tagActiveIndex)
```
    Return the relative search index type for the index name.
    
    Parameters:
    
    indexName - the name of the index
    
    bdefActiveIndex - the name of the active index for business object definitions
    
    tagActiveIndex - the name os the active index for tags
    
    Returns:
    
    the search index type
  - getAggregationsFromNestedAggregation
```
protected Aggregations getAggregationsFromNestedAggregation(Nested nestedAggregation,
                                                            SearchResponse searchResponse)
```
    Returns a representation of a set of aggregations from the nested aggregation. This method also validates that the retrieved object is not null.
    
    Parameters:
    
    nestedAggregation - the nested aggregation
    
    searchResponse - the response of the search request
    
    Returns:
    
    the aggregations
  - getAggregationsFromSearchResponse
```
protected Aggregations getAggregationsFromSearchResponse(SearchResponse searchResponse)
```
    Returns a representation of a set of aggregations from the search response. This method also validates that the retrieved object is not null.
    
    Parameters:
    
    searchResponse - the response of the search request
    
    Returns:
    
    the aggregations

Class ElasticsearchHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISPLAY_NAME_SOURCE

NESTED_BDEFTAGS_PATH

TAGTYPE_CODE_FIELD_TAG_INDEX

TAGTYPE_NAME_FIELD_TAG_INDEX

TAG_CODE_FIELD_TAG_INDEX

TAG_NAME_FIELD_TAG_INDEX

BDEF_TAGTYPE_CODE_FIELD

BDEF_TAGTYPE_NAME_FIELD

BDEF_TAG_CODE_FIELD

BDEF_TAG_NAME_FIELD

TAG_TAG_CODE_FIELD

TAG_TAGTYPE_CODE_FIELD

TAG_FACET_AGGS

TAGTYPE_CODE_AGGREGATION

TAGTYPE_NAME_AGGREGATION

TAG_CODE_AGGREGATION

TAG_NAME_AGGREGATION

TAG_FACET

RESULT_TYPE_FACET

TAG_TYPE_FACET_AGGS

RESULT_TYPE_AGGS

RESULT_TYPE_FIELD

Constructor Detail

ElasticsearchHelper

Method Detail

addFacetFieldAggregations

addIndexSearchFilterBooleanClause

getResultTypeIndexSearchResponseDto

getResultTypeIndexSearchResponseDto

getTagTagIndexSearchResponseDto

getTagTagIndexSearchResponseDto

getNestedTagTagIndexSearchResponseDto

getNestedTagTagIndexSearchResponseDto

getFacetsResponse

getAggregation

getNestedAggregation

getSearchIndexType

getAggregationsFromNestedAggregation

getAggregationsFromSearchResponse