Package org.apache.lucene.facet.taxonomy
Class FloatTaxonomyFacets
java.lang.Object
org.apache.lucene.facet.Facets
org.apache.lucene.facet.taxonomy.TaxonomyFacets
org.apache.lucene.facet.taxonomy.FloatTaxonomyFacets
- Direct Known Subclasses:
TaxonomyFacetFloatAssociations
Deprecated.
Base class for all taxonomy-based facets that aggregate to a per-ords float[].
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
Deprecated.An accumulator for a float aggregated value.Nested classes/interfaces inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
TaxonomyFacets.AggregatedValue
-
Field Summary
Modifier and TypeFieldDescriptionprotected final AssociationAggregationFunction
Deprecated.Aggregation function used for combining values.protected float[]
Deprecated.Per-ordinal value.Fields inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
config, indexFieldName, taxoReader, valueComparator
-
Constructor Summary
ModifierConstructorDescriptionprotected
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. -
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
Deprecated.If not done already, initialize the data structures storing counts.protected TopOrdAndNumberQueue
makeTopOrdAndNumberQueue
(int topN) Deprecated.Return aTopOrdAndNumberQueue
of the appropriate type, i.e.protected Number
Deprecated.Return the value for a missing aggregation, i.e.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, 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 float[] valuesDeprecated.Per-ordinal value.
-
-
Constructor Details
-
FloatTaxonomyFacets
protected FloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) throws IOException Deprecated.Constructor that defaults the aggregation function toAssociationAggregationFunction.SUM
.- Throws:
IOException
-
FloatTaxonomyFacets
protected FloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, AssociationAggregationFunction aggregationFunction, FacetsConfig config, 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
-
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
-
makeTopOrdAndNumberQueue
Deprecated.Description copied from class:TaxonomyFacets
Return aTopOrdAndNumberQueue
of the appropriate type, i.e. aTopOrdAndIntNumberQueue
or aTopOrdAndFloatNumberQueue
.- Overrides:
makeTopOrdAndNumberQueue
in classTaxonomyFacets
-
missingAggregationValue
Deprecated.Description copied from class:TaxonomyFacets
Return the value for a missing aggregation, i.e.-1
or-1f
.- Overrides:
missingAggregationValue
in classTaxonomyFacets
-
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
-
Facets
implementations. If your code is relying on this, please migrate necessary functionality down into your own class.