Module org.apache.lucene.facet

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-created Facets implementations. 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 class	FloatTaxonomyFacets.FloatAggregatedValue	Deprecated. An accumulator for a float aggregated value.

Nested classes/interfaces inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets

TaxonomyFacets.AggregatedValue, TaxonomyFacets.TopChildrenForPath

Field Summary

Fields

Modifier and Type	Field	Description
protected final AssociationAggregationFunction	aggregationFunction	Deprecated. Aggregation function used for combining values.
(package private) IntFloatHashMap	sparseValues	Deprecated. Sparse ordinal values.
protected float[]	values	Deprecated. Per-ordinal value.

Fields inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets

config, counts, fc, indexFieldName, initialized, parents, sparseCounts, taxoReader, valueComparator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FloatTaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)	Deprecated. Constructor that defaults the aggregation function to AssociationAggregationFunction.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 Type	Method	Description
protected Number	aggregate(Number existingVal, Number newVal)	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.
(package private) float	getValue(int ordinal)	Deprecated. Get the value associated with this ordinal.
protected void	initializeValueCounters()	Deprecated. If not done already, initialize the data structures storing counts.
protected TopOrdAndNumberQueue	makeTopOrdAndNumberQueue(int topN)	Deprecated. Return a TopOrdAndNumberQueue of the appropriate type, i.e.
protected Number	missingAggregationValue()	Deprecated. Return the value for a missing aggregation, i.e.
protected TaxonomyFacets.AggregatedValue	newAggregatedValue()	Deprecated. Initialize an accumulator.
private float	rollup(int ord)	Deprecated.
protected void	setIncomingValue(TopOrdAndNumberQueue.OrdAndValue incomingOrdAndValue, int ord)	Deprecated. Set the value for a TopOrdAndNumberQueue.OrdAndValue to the one corresponding to the given ordinal.
(package private) void	setValue(int ordinal, float newValue)	Deprecated. Set the value associated with this ordinal to newValue.
protected void	updateValueFromRollup(int ordinal, int childOrdinal)	Deprecated. Roll-up the aggregation values from childOrdinal to ordinal.

Methods inherited from class org.apache.lucene.facet.taxonomy.TaxonomyFacets

childrenLoaded, getAllChildren, getAllDims, getChildren, getCount, getSiblings, getSpecificValue, getTopChildren, getTopChildrenForPath, getTopDims, hasValues, insertIntoQueue, rollup, setCount, siblingsLoaded, useHashTable, verifyDim

Methods inherited from class org.apache.lucene.facet.Facets

validateTopN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

aggregationFunction

protected final AssociationAggregationFunction aggregationFunction

Deprecated.

Aggregation function used for combining values.

values

protected float[] values

Deprecated.

Per-ordinal value.

sparseValues

IntFloatHashMap sparseValues

Deprecated.

Sparse ordinal values.

Constructor Details

FloatTaxonomyFacets

protected FloatTaxonomyFacets(String indexFieldName,
 TaxonomyReader taxoReader,
 FacetsConfig config)
                       throws IOException

Deprecated.

Constructor that defaults the aggregation function to AssociationAggregationFunction.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 class TaxonomyFacets

setValue

void setValue(int ordinal,
 float newValue)

Deprecated.

Set the value associated with this ordinal to newValue.

getValue

float getValue(int ordinal)

Deprecated.

Get the value associated with this ordinal.

getAggregationValue

protected Number getAggregationValue(int ordinal)

Deprecated.

Description copied from class: TaxonomyFacets

Get the aggregation value for this ordinal.

Overrides:

getAggregationValue in class TaxonomyFacets

aggregate

protected Number aggregate(Number existingVal,
 Number newVal)

Deprecated.

Description copied from class: TaxonomyFacets

Apply an aggregation to the two values and return the result.

Overrides:

aggregate in class TaxonomyFacets

updateValueFromRollup

protected void updateValueFromRollup(int ordinal,
 int childOrdinal)
                              throws IOException

Deprecated.

Description copied from class: TaxonomyFacets

Roll-up the aggregation values from childOrdinal to ordinal. 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 class TaxonomyFacets

Throws:

IOException

makeTopOrdAndNumberQueue

protected TopOrdAndNumberQueue makeTopOrdAndNumberQueue(int topN)

Deprecated.

Description copied from class: TaxonomyFacets

Return a TopOrdAndNumberQueue of the appropriate type, i.e. a TopOrdAndIntNumberQueue or a TopOrdAndFloatNumberQueue.

Overrides:

makeTopOrdAndNumberQueue in class TaxonomyFacets

missingAggregationValue

protected Number missingAggregationValue()

Deprecated.

Description copied from class: TaxonomyFacets

Return the value for a missing aggregation, i.e. -1 or -1f.

Overrides:

missingAggregationValue in class TaxonomyFacets

rollup

private float rollup(int ord)
              throws IOException

Deprecated.

Throws:

IOException

setIncomingValue

protected void setIncomingValue(TopOrdAndNumberQueue.OrdAndValue incomingOrdAndValue,
 int ord)

Deprecated.

Description copied from class: TaxonomyFacets

Set the value for a TopOrdAndNumberQueue.OrdAndValue to the one corresponding to the given ordinal.

Overrides:

setIncomingValue in class TaxonomyFacets

newAggregatedValue

protected TaxonomyFacets.AggregatedValue newAggregatedValue()

Deprecated.

Description copied from class: TaxonomyFacets

Initialize an accumulator.

Overrides:

newAggregatedValue in class TaxonomyFacets