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 public abstract class FloatTaxonomyFacets extends TaxonomyFacets
Deprecated.Visibility of this class will be reduced to pkg-private in a future version. This class is meant to host common code as an internal implementation detail to taxonomy faceting,and is not intended as an extension point for user-createdFacetsimplementations. If your code is relying on this, please migrate necessary functionality down into your own class.Base class for all taxonomy-based facets that aggregate to a per-ords float[].
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classFloatTaxonomyFacets.FloatAggregatedValueDeprecated.An accumulator for a float aggregated value.-
Nested classes/interfaces inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
TaxonomyFacets.AggregatedValue
-
-
Field Summary
Fields Modifier and Type Field Description protected AssociationAggregationFunctionaggregationFunctionDeprecated.Aggregation function used for combining values.protected float[]valuesDeprecated.Per-ordinal value.-
Fields inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets
config, indexFieldName, taxoReader, valueComparator
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)Deprecated.Constructor that defaults the aggregation function toAssociationAggregationFunction.SUM.protectedFloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, AssociationAggregationFunction aggregationFunction, FacetsConfig config, FacetsCollector fc)Deprecated.Constructor that uses the provided aggregation function.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Numberaggregate(Number existingVal, Number newVal)Deprecated.Apply an aggregation to the two values and return the result.protected NumbergetAggregationValue(int ordinal)Deprecated.Get the aggregation value for this ordinal.protected voidinitializeValueCounters()Deprecated.If not done already, initialize the data structures storing counts.protected TopOrdAndNumberQueuemakeTopOrdAndNumberQueue(int topN)Deprecated.Return aTopOrdAndNumberQueueof the appropriate type, i.e.protected NumbermissingAggregationValue()Deprecated.Return the value for a missing aggregation, i.e.protected TaxonomyFacets.AggregatedValuenewAggregatedValue()Deprecated.Initialize an accumulator.protected voidsetIncomingValue(TopOrdAndNumberQueue.OrdAndValue incomingOrdAndValue, int ord)Deprecated.Set the value for aTopOrdAndNumberQueue.OrdAndValueto the one corresponding to the given ordinal.protected voidupdateValueFromRollup(int ordinal, int childOrdinal)Deprecated.Roll-up the aggregation values fromchildOrdinaltoordinal.-
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 Detail
-
aggregationFunction
protected final AssociationAggregationFunction aggregationFunction
Deprecated.Aggregation function used for combining values.
-
values
protected float[] values
Deprecated.Per-ordinal value.
-
-
Constructor Detail
-
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 Detail
-
initializeValueCounters
protected void initializeValueCounters()
Deprecated.Description copied from class:TaxonomyFacetsIf not done already, initialize the data structures storing counts.- Overrides:
initializeValueCountersin classTaxonomyFacets
-
getAggregationValue
protected Number getAggregationValue(int ordinal)
Deprecated.Description copied from class:TaxonomyFacetsGet the aggregation value for this ordinal.- Overrides:
getAggregationValuein classTaxonomyFacets
-
aggregate
protected Number aggregate(Number existingVal, Number newVal)
Deprecated.Description copied from class:TaxonomyFacetsApply an aggregation to the two values and return the result.- Overrides:
aggregatein classTaxonomyFacets
-
updateValueFromRollup
protected void updateValueFromRollup(int ordinal, int childOrdinal) throws IOExceptionDeprecated.Description copied from class:TaxonomyFacetsRoll-up the aggregation values fromchildOrdinaltoordinal. 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:
updateValueFromRollupin classTaxonomyFacets- Throws:
IOException
-
makeTopOrdAndNumberQueue
protected TopOrdAndNumberQueue makeTopOrdAndNumberQueue(int topN)
Deprecated.Description copied from class:TaxonomyFacetsReturn aTopOrdAndNumberQueueof the appropriate type, i.e. aTopOrdAndIntNumberQueueor aTopOrdAndFloatNumberQueue.- Overrides:
makeTopOrdAndNumberQueuein classTaxonomyFacets
-
missingAggregationValue
protected Number missingAggregationValue()
Deprecated.Description copied from class:TaxonomyFacetsReturn the value for a missing aggregation, i.e.-1or-1f.- Overrides:
missingAggregationValuein classTaxonomyFacets
-
setIncomingValue
protected void setIncomingValue(TopOrdAndNumberQueue.OrdAndValue incomingOrdAndValue, int ord)
Deprecated.Description copied from class:TaxonomyFacetsSet the value for aTopOrdAndNumberQueue.OrdAndValueto the one corresponding to the given ordinal.- Overrides:
setIncomingValuein classTaxonomyFacets
-
newAggregatedValue
protected TaxonomyFacets.AggregatedValue newAggregatedValue()
Deprecated.Description copied from class:TaxonomyFacetsInitialize an accumulator.- Overrides:
newAggregatedValuein classTaxonomyFacets
-
-