Uses of Class
de.cxp.ocs.config.FacetConfiguration.FacetConfig

Packages that use FacetConfiguration.FacetConfig

Package	Description
de.cxp.ocs.config
de.cxp.ocs.elasticsearch.facets
de.cxp.ocs.elasticsearch.facets.helper
de.cxp.ocs.spi.search
de.cxp.ocs.util

Uses of FacetConfiguration.FacetConfig in de.cxp.ocs.config

Methods in de.cxp.ocs.config that return FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setExcludeFromFacetLimit(boolean excludeFromFacetLimit)	If set to true, this facet will always be shown and not removed because of facet limit.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setFilterDependencies(String... filterDependencies)	Set one or more URL-style filters of other facets that are required to make this facet visible.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setFilterSensitive(boolean isFilterSensitive)	Set to true if the attributes for a facet can have multiple values per document, but the facet should only return the filtered one.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setIsFilterSensitive(boolean isFilterSensitive)
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setIsMultiSelect(boolean isMultiSelect)
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setLabel(String label)	Label of that facet
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setMetaData(Map<String,Object> metaData)	Optional map that is returned with that facet.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setMinFacetCoverage(double minFacetCoverage)	Set the minimum ratio of the result a facet has to cover in order to be displayed.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setMinValueCount(int minValueCount)	Set the minimum amount of values a facet must have in order to be displayed.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setMultiSelect(boolean isMultiSelect)	Set to true if it should be possible to select several different values of the same facet.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setOptimalValueCount(int optimalValueCount)	Primary used for numeric facets to build according number of value ranges / intervals.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setOrder(int order)	Optional index, to put the facets in a consistent order.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setPreferVariantOnFilter(boolean preferVariantOnFilter)	Set to true, if variant documents should be preferred in the result in case a filter of that facet/field is used.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setRemoveOnSingleFullCoverageFacetElement(boolean enable)	If set to true, that facet is removed in case it has a single element that covers all result products.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setShowUnselectedOptions(boolean showUnselectedOptions)	Set to true if all options should be shown after filtering on one of the options of the same facet.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setSourceField(String sourceField)	Required: Set name of data field that is configured with these config.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setType(String type)	Optional type that relates to the available FacetCreators.
FacetConfiguration.FacetConfig	FacetConfiguration.FacetConfig.setValueOrder(FacetConfiguration.FacetConfig.ValueOrder valueOrder)	Set the order of the facet values.

Methods in de.cxp.ocs.config with parameters of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
FacetConfiguration	FacetConfiguration.setDefaultFacetConfiguration(FacetConfiguration.FacetConfig defaultFacetConfiguration)	Deprecated.
FacetConfiguration	FacetConfiguration.setDefaultNumberFacetConfiguration(FacetConfiguration.FacetConfig defaultNumberFacetConfiguration)
FacetConfiguration	FacetConfiguration.setDefaultTermFacetConfiguration(FacetConfiguration.FacetConfig defaultTermFacetConfiguration)

Method parameters in de.cxp.ocs.config with type arguments of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
FacetConfiguration	FacetConfiguration.setFacets(@NonNull List<FacetConfiguration.FacetConfig> facets)	A list of fine grained facet configurations.

Uses of FacetConfiguration.FacetConfig in de.cxp.ocs.elasticsearch.facets

Methods in de.cxp.ocs.elasticsearch.facets with parameters of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
static Facet	FacetFactory.create(FacetConfiguration.FacetConfig facetConfig, FacetType type)
static Facet	FacetFactory.create(FacetConfiguration.FacetConfig facetConfig, String type)
protected Optional<Facet>	CategoryFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter intFacetFilter, DefaultLinkBuilder linkBuilder)
Optional<Facet>	FixedIntervalFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, LinkBuilder linkBuilder, Function<org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket,Long> nestedValueBucketDocCountCorrector)
protected Optional<Facet>	IntervalFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
protected Optional<Facet>	NestedCustomFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
protected abstract Optional<Facet>	NestedFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
protected Optional<Facet>	RangeFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
protected Optional<Facet>	TermFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, DefaultLinkBuilder linkBuilder)
String	TermFacetCreator.createFacetLink(TermResultFilter facetFilter, FacetConfiguration.FacetConfig facetConfig, DefaultLinkBuilder linkBuilder, String facetValue, String facetValueId, boolean isSelected)
protected FacetEntry	FixedIntervalFacetCreator.createIntervalFacetEntry(NumericFacetEntryBuilder currentValueInterval, NumberResultFilter selectedFilter, FacetConfiguration.FacetConfig facetConfig, LinkBuilder linkBuilder)
protected FacetEntry	IntervalFacetCreator.createIntervalFacetEntry(NumericFacetEntryBuilder currentValueInterval, NumberResultFilter selectedFilter, FacetConfiguration.FacetConfig facetConfig, DefaultLinkBuilder linkBuilder)
protected <T extends Number> void	FixedIntervalFacetCreator.fillFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, Facet facet, FacetConfiguration.FacetConfig facetConfig, LinkBuilder linkBuilder, NumberResultFilter selectedFilter, Function<org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket,Long> nestedValueBucketDocCountCorrector)
boolean	FacetCoverageFilter.isVisibleFacet(Facet facet, FacetConfiguration.FacetConfig config, FilterContext filterContext, int totalMatchCount)
boolean	FacetDependencyFilter.isVisibleFacet(Facet facet, FacetConfiguration.FacetConfig config, FilterContext filterContext, int totalMatchCount)
boolean	FacetFilter.isVisibleFacet(Facet facet, FacetConfiguration.FacetConfig config, FilterContext filterContext, int totalMatchCount)
boolean	FacetSizeFilter.isVisibleFacet(Facet facet, FacetConfiguration.FacetConfig config, FilterContext filterContext, int totalMatchCount)

Constructor parameters in de.cxp.ocs.elasticsearch.facets with type arguments of type FacetConfiguration.FacetConfig

Modifier	Constructor	Description
	CategoryFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	CategoryFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	CategoryFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, boolean isExplicitFacetCreator)
	CategoryFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, boolean isExplicitFacetCreator)
	FacetDependencyFilter(Map<String,FacetConfiguration.FacetConfig> facetsBySourceField)
	IntervalFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	IntervalFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	NestedCustomFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, @NonNull FieldType fieldType, boolean variantLevel, @NonNull CustomFacetCreator customFacetCreator)
	NestedFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	NestedFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	RangeFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	RangeFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider)
	TermFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, Locale l)
	TermFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, Locale l)
	TermFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, Locale l, boolean createConfiguredFacetsOnly)
	TermFacetCreator(Map<String,FacetConfiguration.FacetConfig> facetConfigs, Function<String,FacetConfiguration.FacetConfig> defaultFacetConfigProvider, Locale l, boolean createConfiguredFacetsOnly)

Uses of FacetConfiguration.FacetConfig in de.cxp.ocs.elasticsearch.facets.helper

Methods in de.cxp.ocs.elasticsearch.facets.helper with parameters of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
String	NumericFacetEntryBuilder.getLabel(FacetConfiguration.FacetConfig facetConfig)	Sophisticated interval label that considers nullable lower or upper bound value or if this interval is the first or last one.

Uses of FacetConfiguration.FacetConfig in de.cxp.ocs.spi.search

Methods in de.cxp.ocs.spi.search with parameters of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
Optional<Facet>	CustomFacetCreator.createFacet(org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket facetNameBucket, FacetConfiguration.FacetConfig facetConfig, InternalResultFilter facetFilter, LinkBuilder linkBuilder, Function<org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket,Long> nestedValueBucketDocCountCorrector)	Create a facet from the given aggregation result.

Uses of FacetConfiguration.FacetConfig in de.cxp.ocs.util

Methods in de.cxp.ocs.util with parameters of type FacetConfiguration.FacetConfig

Modifier and Type	Method	Description
String	DefaultLinkBuilder.withExactFilterAsLink(FacetConfiguration.FacetConfig facetConfig, String... filterInputValues)	Returns a URL with that filter set.
String	DefaultLinkBuilder.withFilterAsLink(FacetConfiguration.FacetConfig facetConfig, String... filterInputValues)
String	DefaultLinkBuilder.withoutFilterAsLink(FacetConfiguration.FacetConfig facetConfig)	Removes the complete filter parameter and returns the link.
String	DefaultLinkBuilder.withoutFilterAsLink(FacetConfiguration.FacetConfig facetConfig, String... filterValues)