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:

TaxonomyFacetSumFloatAssociations, TaxonomyFacetSumValueSource

public abstract class FloatTaxonomyFacets
extends TaxonomyFacets

Base class for all taxonomy-based facets that aggregate to a per-ords float[].

Field Summary

Fields

Modifier and Type	Field and Description
protected float[]	values Per-ordinal value.

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

config, indexFieldName, parents, taxoReader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FloatTaxonomyFacets(java.lang.String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) Sole constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getSpecificValue(java.lang.String dim, java.lang.String... path) Return the count or value for a specific path.
FacetResult	getTopChildren(int topN, java.lang.String dim, java.lang.String... path) Returns the topN child labels under the specified path.
protected void	rollup() Rolls up any single-valued hierarchical dimensions.

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

childrenLoaded, getAllDims, getChildren, getSiblings, siblingsLoaded, verifyDim

Methods inherited from class java.lang.Object

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

Field Detail

values

protected final float[] values

Per-ordinal value.

Constructor Detail

FloatTaxonomyFacets

protected FloatTaxonomyFacets(java.lang.String indexFieldName,
                              TaxonomyReader taxoReader,
                              FacetsConfig config)
                       throws java.io.IOException

Sole constructor.

Throws:

java.io.IOException

Method Detail

rollup

protected void rollup()
               throws java.io.IOException

Rolls up any single-valued hierarchical dimensions.

Throws:

java.io.IOException

getSpecificValue

public java.lang.Number getSpecificValue(java.lang.String dim,
                                         java.lang.String... path)
                                  throws java.io.IOException

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 class Facets

Throws:

java.io.IOException

getTopChildren

public FacetResult getTopChildren(int topN,
                                  java.lang.String dim,
                                  java.lang.String... path)
                           throws java.io.IOException

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 class Facets

Throws:

java.io.IOException