Package de.cxp.ocs.elasticsearch.facets

Class RangeFacetCreator

java.lang.Object

de.cxp.ocs.elasticsearch.facets.NestedFacetCreator

de.cxp.ocs.elasticsearch.facets.RangeFacetCreator

All Implemented Interfaces:

FacetCreator

public class RangeFacetCreator
extends NestedFacetCreator

Creates a facet with a single IntervalFacetEntry that contains the global min and max value. (Therefore it uses the "stats" aggregation - not the range aggregationas the name might imply.)

At the moment, a selected filter range is represented at the returned link of that IntervalFacetEntry.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGGREGATION_NAME

Fields inherited from class de.cxp.ocs.elasticsearch.facets.NestedFacetCreator

nestedFacetCorrector

Constructor Summary

Constructors

Constructor	Description
RangeFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)

Method Summary

Modifier and Type	Method	Description
protected boolean	correctedNestedDocumentCount()
protected Optional<Facet>	createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
protected String	getNestedPath()
protected org.elasticsearch.search.aggregations.AggregationBuilder	getNestedValueAggregation(String nestedPathPrefix)
protected boolean	isMatchingFilterType(InternalResultFilter internalResultFilter)
Optional<Facet>	mergeFacets(Facet first, Facet second)	Try to merge facets with same label.
protected boolean	onlyFetchAggregationsForConfiguredFacets()

Methods inherited from class de.cxp.ocs.elasticsearch.facets.NestedFacetCreator

buildAggregation, buildExcludeFilteredAggregation, buildIncludeFilteredAggregation, createFacets, extractFacets

Methods inherited from class java.lang.Object

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

Field Details

AGGREGATION_NAME

public static final String AGGREGATION_NAME

See Also:

• Constant Field Values

Constructor Details

RangeFacetCreator

public RangeFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs,
 Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)

Method Details

getNestedPath

protected String getNestedPath()

Specified by:

getNestedPath in class NestedFacetCreator

onlyFetchAggregationsForConfiguredFacets

protected boolean onlyFetchAggregationsForConfiguredFacets()

Specified by:

onlyFetchAggregationsForConfiguredFacets in class NestedFacetCreator

correctedNestedDocumentCount

protected boolean correctedNestedDocumentCount()

Specified by:

correctedNestedDocumentCount in class NestedFacetCreator

isMatchingFilterType

protected boolean isMatchingFilterType(InternalResultFilter internalResultFilter)

Specified by:

isMatchingFilterType in class NestedFacetCreator

getNestedValueAggregation

protected org.elasticsearch.search.aggregations.AggregationBuilder getNestedValueAggregation(String nestedPathPrefix)

Specified by:

getNestedValueAggregation in class NestedFacetCreator

createFacet

protected Optional<Facet> createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket,
 FacetConfiguration.FacetConfig facetConfig,
 InternalResultFilter facetFilter,
 DefaultLinkBuilder linkBuilder)

Specified by:

createFacet in class NestedFacetCreator

mergeFacets

public Optional<Facet> mergeFacets(Facet first,
 Facet second)

Description copied from interface: FacetCreator

Try to merge facets with same label. If not possible, return Optional.empty.

Parameters:

first - Facet A

second - Facet B

Returns:

optionally a merged Facet, otherwise Optional::empty