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:
TaxonomyFacetCounts
,TaxonomyFacetIntAssociations
Deprecated.
Base class for all taxonomy-based facets that aggregate to a per-ords int[].
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
Deprecated.An accumulator for an integer aggregated value.Nested classes/interfaces inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
TaxonomyFacets.AggregatedValue
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final AssociationAggregationFunction
Deprecated.Aggregation function used for combining values.protected IntIntHashMap
Deprecated.Sparse ordinal values.protected int[]
Deprecated.Dense ordinal values.Fields inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
config, indexFieldName, taxoReader, valueComparator
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
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 TypeMethodDescriptionprotected Number
Deprecated.Apply an aggregation to the two values and return the result.protected Number
getAggregationValue
(int ordinal) Deprecated.Get the aggregation value 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
Deprecated.If not done already, initialize the data structures storing counts.protected TaxonomyFacets.AggregatedValue
Deprecated.Initialize an accumulator.protected void
setIncomingValue
(TopOrdAndNumberQueue.OrdAndValue incomingOrdAndValue, int ord) Deprecated.Set the value for aTopOrdAndNumberQueue.OrdAndValue
to the one corresponding to the given ordinal.protected void
updateValueFromRollup
(int ordinal, int childOrdinal) Deprecated.Roll-up the aggregation values fromchildOrdinal
toordinal
.Methods inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
childrenLoaded, getAllChildren, getAllDims, getCount, getSpecificValue, getTopChildren, getTopChildrenForPath, getTopDims, insertIntoQueue, makeTopOrdAndNumberQueue, missingAggregationValue, rollup, setCount, siblingsLoaded, useHashTable, verifyDim
Methods inherited from class org.apache.lucene.facet.Facets
validateTopN
-
Field Details
-
aggregationFunction
Deprecated.Aggregation function used for combining values. -
values
protected 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
Deprecated.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
-
initializeValueCounters
protected void initializeValueCounters()Deprecated.Description copied from class:TaxonomyFacets
If not done already, initialize the data structures storing counts.- Overrides:
initializeValueCounters
in classTaxonomyFacets
-
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
.. -
getAggregationValue
Deprecated.Description copied from class:TaxonomyFacets
Get the aggregation value for this ordinal.- Overrides:
getAggregationValue
in classTaxonomyFacets
-
aggregate
Deprecated.Description copied from class:TaxonomyFacets
Apply an aggregation to the two values and return the result.- Overrides:
aggregate
in classTaxonomyFacets
-
updateValueFromRollup
Deprecated.Description copied from class:TaxonomyFacets
Roll-up the aggregation values fromchildOrdinal
toordinal
. Overrides should probably call this to update the counts. Overriding allows us to work with primitive types for the aggregation values, keeping aggregation efficient.- Overrides:
updateValueFromRollup
in classTaxonomyFacets
- Throws:
IOException
-
setIncomingValue
Deprecated.Description copied from class:TaxonomyFacets
Set the value for aTopOrdAndNumberQueue.OrdAndValue
to the one corresponding to the given ordinal.- Overrides:
setIncomingValue
in classTaxonomyFacets
-
newAggregatedValue
Deprecated.Description copied from class:TaxonomyFacets
Initialize an accumulator.- Overrides:
newAggregatedValue
in classTaxonomyFacets
-
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.