Uses of Class
org.apache.lucene.facet.FacetsConfig
Packages that use FacetsConfig
Package
Description
Faceted search.
Provides faceting capabilities over facets that were indexed with
SortedSetDocValuesFacetField
.Taxonomy of Categories.
-
Uses of FacetsConfig in org.apache.lucene.facet
Fields in org.apache.lucene.facet declared as FacetsConfigModifier and TypeFieldDescriptionprotected final FacetsConfig
DrillSideways.config
FacetsConfig
passed to constructor.Methods in org.apache.lucene.facet with parameters of type FacetsConfigModifier and TypeMethodDescriptionRandomSamplingFacetsCollector.amortizeFacetCounts
(FacetResult res, FacetsConfig config, IndexSearcher searcher) Note: if you use a countingFacets
implementation, you can amortize the sampled counts by calling this method.Constructors in org.apache.lucene.facet with parameters of type FacetsConfigModifierConstructorDescriptionDrillDownQuery
(FacetsConfig config) Creates a newDrillDownQuery
without a base query, to perform a pure browsing query (equivalent to usingMatchAllDocsQuery
as base).DrillDownQuery
(FacetsConfig config, Query baseQuery) Creates a newDrillDownQuery
over the given base query.DrillSideways
(IndexSearcher searcher, FacetsConfig config, SortedSetDocValuesReaderState state) Create a newDrillSideways
instance, assuming the categories were indexed withSortedSetDocValuesFacetField
.DrillSideways
(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader) Create a newDrillSideways
instance.DrillSideways
(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state) Create a newDrillSideways
instance, where some dimensions were indexed withSortedSetDocValuesFacetField
and others were indexed withFacetField
.DrillSideways
(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state, ExecutorService executor) Create a newDrillSideways
instance, where some dimensions were indexed withSortedSetDocValuesFacetField
and others were indexed withFacetField
.FacetQuery
(FacetsConfig facetsConfig, String dimension, String... path) Creates a newFacetQuery
filtering the query on the given dimension.MultiFacetQuery
(FacetsConfig facetsConfig, String dimension, String[]... paths) Creates a newMultiFacetQuery
filtering the query on the given dimension. -
Uses of FacetsConfig in org.apache.lucene.facet.sortedset
Methods in org.apache.lucene.facet.sortedset that return FacetsConfigModifier and TypeMethodDescriptionDefaultSortedSetDocValuesReaderState.getFacetsConfig()
abstract FacetsConfig
SortedSetDocValuesReaderState.getFacetsConfig()
Returns the associated facet config.Constructors in org.apache.lucene.facet.sortedset with parameters of type FacetsConfigModifierConstructorDescriptionDefaultSortedSetDocValuesReaderState
(IndexReader reader, String field, FacetsConfig config) Creates this, pulling doc values from the specified field.DefaultSortedSetDocValuesReaderState
(IndexReader reader, FacetsConfig config) Creates this with a config, pulling doc values from the defaultDEFAULT_INDEX_FIELD_NAME
. -
Uses of FacetsConfig in org.apache.lucene.facet.taxonomy
Fields in org.apache.lucene.facet.taxonomy declared as FacetsConfigModifier and TypeFieldDescriptionprotected final FacetsConfig
TaxonomyFacets.config
Deprecated.FacetsConfig
provided to the constructor.Methods in org.apache.lucene.facet.taxonomy with parameters of type FacetsConfigModifier and TypeMethodDescriptionstatic void
TaxonomyMergeUtils.merge
(Directory srcIndexDir, Directory srcTaxoDir, DirectoryTaxonomyWriter.OrdinalMap map, IndexWriter destIndexWriter, DirectoryTaxonomyWriter destTaxoWriter, FacetsConfig srcConfig) Merges the given taxonomy and index directories and commits the changes to the given writers.Constructors in org.apache.lucene.facet.taxonomy with parameters of type FacetsConfigModifierConstructorDescriptionFastTaxonomyFacetCounts
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) CreateFastTaxonomyFacetCounts
, using the specifiedindexFieldName
for ordinals.FastTaxonomyFacetCounts
(String indexFieldName, IndexReader reader, TaxonomyReader taxoReader, FacetsConfig config) CreateFastTaxonomyFacetCounts
, using the specifiedindexFieldName
for ordinals, and counting all non-deleted documents in the index.FastTaxonomyFacetCounts
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) CreateFastTaxonomyFacetCounts
, which also counts all facet labels.protected
FloatTaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) Deprecated.Constructor that defaults the aggregation function toAssociationAggregationFunction.SUM
.protected
FloatTaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, AssociationAggregationFunction aggregationFunction, FacetsConfig config, FacetsCollector fc) Deprecated.Constructor that uses the provided aggregation function.protected
IntTaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.Constructor that defaults the aggregation function toAssociationAggregationFunction.SUM
.protected
IntTaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, AssociationAggregationFunction aggregationFunction, FacetsCollector fc) Deprecated.Constructor that uses the provided aggregation function.OrdinalMappingLeafReader
(LeafReader in, int[] ordinalMap, FacetsConfig srcConfig) Wraps an LeafReader, mapping ordinals according to the ordinalMap, using the providedFacetsConfig
which was used to build the wrapped reader.TaxonomyFacetCounts
(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.CreateTaxonomyFacetCounts
, which also counts all facet labels.TaxonomyFacetFloatAssociations
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction) CreateTaxonomyFacetFloatAssociations
against the specified index field.TaxonomyFacetFloatAssociations
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource) CreateTaxonomyFacetFloatAssociations
against the specified index field.TaxonomyFacetFloatAssociations
(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource) Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9TaxonomyFacetFloatAssociations
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction) CreateTaxonomyFacetFloatAssociations
against the default index field.TaxonomyFacetFloatAssociations
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction, DoubleValuesSource valuesSource) CreateTaxonomyFacetFloatAssociations
against the default index field.TaxonomyFacetIntAssociations
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction) CreateTaxonomyFacetIntAssociations
against the specified index field.TaxonomyFacetIntAssociations
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, AssociationAggregationFunction aggregationFunction) CreateTaxonomyFacetIntAssociations
against the default index field.protected
TaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) Deprecated.To be removed in Lucene 10.TaxonomyFacetSumFloatAssociations
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.CreateTaxonomyFacetSumFloatAssociations
against the specified index field.TaxonomyFacetSumFloatAssociations
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.CreateTaxonomyFacetSumFloatAssociations
against the default index field.TaxonomyFacetSumIntAssociations
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.CreateTaxonomyFacetSumIntAssociations
against the specified index field.TaxonomyFacetSumIntAssociations
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) Deprecated.CreateTaxonomyFacetSumIntAssociations
against the default index field.TaxonomyFacetSumValueSource
(String indexField, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource valueSource) Deprecated.Aggregates double facet values from the providedDoubleValuesSource
, pulling ordinals from the specified indexed facet field.TaxonomyFacetSumValueSource
(OrdinalsReader ordinalsReader, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource vs) Deprecated.Custom binary encodings for taxonomy ordinals are no longer supported starting with Lucene 9TaxonomyFacetSumValueSource
(TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc, DoubleValuesSource valueSource) Deprecated.Aggregates double facet values from the providedDoubleValuesSource
, pulling ordinals from the default indexed facet fieldDEFAULT_INDEX_FIELD_NAME
.