Package org.apache.lucene.facet.taxonomy
Class IntTaxonomyFacets
java.lang.Object
org.apache.lucene.facet.Facets
org.apache.lucene.facet.taxonomy.TaxonomyFacets
org.apache.lucene.facet.taxonomy.IntTaxonomyFacets
- Direct Known Subclasses:
FastTaxonomyFacetCounts
,TaxonomyFacetCounts
,TaxonomyFacetIntAssociations
Deprecated.
Base class for all taxonomy-based facets that aggregate to a per-ords int[].
-
Field Summary
Modifier and TypeFieldDescriptionprotected final AssociationAggregationFunction
Deprecated.Aggregation function used for combining values.protected final com.carrotsearch.hppc.IntIntHashMap
Deprecated.Sparse ordinal values.protected final int[]
Deprecated.Dense ordinal values.Fields inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
config, indexFieldName, parents, taxoReader
-
Constructor Summary
ModifierConstructorDescriptionprotected
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. -
Method Summary
Modifier and TypeMethodDescriptiongetAllChildren
(String dim, String... path) Deprecated.Returns all child labels with non-zero counts under the specified path.getSpecificValue
(String dim, String... path) Deprecated.Return the count or value for a specific path.getTopChildren
(int topN, String dim, String... path) Deprecated.Returns the topN child labels under the specified path.getTopDims
(int topNDims, int topNChildren) Deprecated.Returns labels for topN dimensions and their topNChildren sorted by the number of hits/aggregated values that dimension matched.protected int
getValue
(int ordinal) Deprecated.Get the count for this ordinal.protected void
increment
(int ordinal) Deprecated.Increment the count for this ordinal by 1.protected void
increment
(int ordinal, int amount) Deprecated.Increment the count for this ordinal byamount
..protected void
rollup()
Deprecated.Rolls up any single-valued hierarchical dimensions.protected boolean
useHashTable
(FacetsCollector fc, TaxonomyReader taxoReader) Deprecated.Return true if a sparse hash table should be used for counting, instead of a dense int[].Methods inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
childrenLoaded, getAllDims, getChildren, getSiblings, siblingsLoaded, verifyDim
Methods inherited from class org.apache.lucene.facet.Facets
validateTopN
-
Field Details
-
aggregationFunction
Deprecated.Aggregation function used for combining values. -
values
protected final int[] valuesDeprecated.Dense ordinal values.We are making this and
sparseValues
protected for some expert usage. e.g. It can be checked which is being used before a loop instead of callingincrement(int)
for each iteration. -
sparseValues
protected final com.carrotsearch.hppc.IntIntHashMap sparseValuesDeprecated.Sparse ordinal values.- See Also:
-
-
Constructor Details
-
IntTaxonomyFacets
protected IntTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, FacetsCollector fc) throws IOException Deprecated.Constructor that defaults the aggregation function toAssociationAggregationFunction.SUM
.- Throws:
IOException
-
IntTaxonomyFacets
protected IntTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config, AssociationAggregationFunction aggregationFunction, FacetsCollector fc) throws IOException Deprecated.Constructor that uses the provided aggregation function.- Throws:
IOException
-
-
Method Details
-
useHashTable
Deprecated.Return true if a sparse hash table should be used for counting, instead of a dense int[]. -
increment
protected void increment(int ordinal) Deprecated.Increment the count for this ordinal by 1. -
increment
protected void increment(int ordinal, int amount) Deprecated.Increment the count for this ordinal byamount
.. -
getValue
protected int getValue(int ordinal) Deprecated.Get the count for this ordinal. -
rollup
Deprecated.Rolls up any single-valued hierarchical dimensions.- Throws:
IOException
-
getSpecificValue
Deprecated.Description copied from class:Facets
Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.- Specified by:
getSpecificValue
in classFacets
- Throws:
IOException
-
getAllChildren
Deprecated.Description copied from class:Facets
Returns all child labels with non-zero counts under the specified path. Users should make no assumptions about ordering of the children. Returns null if the specified path doesn't exist or if this dimension was never seen.- Specified by:
getAllChildren
in classFacets
- Throws:
IOException
-
getTopChildren
Deprecated.Description copied from class:Facets
Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.- Specified by:
getTopChildren
in classFacets
- Throws:
IOException
-
getTopDims
Deprecated.Description copied from class:Facets
Returns labels for topN dimensions and their topNChildren sorted by the number of hits/aggregated values that dimension matched. Results should be the same as calling getAllDims and then only using the first topNDims. Note that dims should be configured as requiring dim counts if using this functionality to ensure accurate counts are available (see:FacetsConfig.setRequireDimCount(String, boolean)
).Sub-classes may want to override this implementation with a more efficient one if they are able.
- Overrides:
getTopDims
in classFacets
- Throws:
IOException
-
FastTaxonomyFacetCounts
andTaxonomyFacetIntAssociations
,and is not intended as an extension point for user-createdFacets
implementations. If your code is relying on this, please migrate necessary functionality down into your own class.