Package org.apache.lucene.facet.taxonomy
Class TaxonomyFacets
java.lang.Object
org.apache.lucene.facet.Facets
org.apache.lucene.facet.taxonomy.TaxonomyFacets
- Direct Known Subclasses:
FloatTaxonomyFacets
,IntTaxonomyFacets
Deprecated.
Base class for all taxonomy-based facets impls.
-
Field Summary
Modifier and TypeFieldDescriptionprotected final FacetsConfig
Deprecated.FacetsConfig
provided to the constructor.protected final String
Deprecated.Index field name provided to the constructor.protected final int[]
Deprecated.Maps an ordinal to its parent, or -1 if there is no parent (root node).protected final TaxonomyReader
Deprecated.TaxonomyReader
provided to the constructor. -
Constructor Summary
ModifierConstructorDescriptionprotected
TaxonomyFacets
(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) Deprecated.Sole constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.Returns true if the (costly, and lazily initialized) children int[] was initialized.getAllDims
(int topN) Deprecated.Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.protected int[]
Deprecated.Returns int[] mapping each ordinal to its first child; this is a large array and is computed (and then saved) the first time this method is invoked.protected int[]
Deprecated.Returns int[] mapping each ordinal to its next sibling; this is a large array and is computed (and then saved) the first time this method is invoked.boolean
Deprecated.Returns true if the (costly, and lazily initialized) sibling int[] was initialized.protected FacetsConfig.DimConfig
Deprecated.Verifies and returnsFacetsConfig.DimConfig
for the given dimension name.Methods inherited from class org.apache.lucene.facet.Facets
getAllChildren, getSpecificValue, getTopChildren, getTopDims, validateTopN
-
Field Details
-
indexFieldName
Deprecated.Index field name provided to the constructor. -
taxoReader
Deprecated.TaxonomyReader
provided to the constructor. -
config
Deprecated.FacetsConfig
provided to the constructor. -
parents
protected final int[] parentsDeprecated.Maps an ordinal to its parent, or -1 if there is no parent (root node).
-
-
Constructor Details
-
TaxonomyFacets
protected TaxonomyFacets(String indexFieldName, TaxonomyReader taxoReader, FacetsConfig config) throws IOException Deprecated.Sole constructor.- Throws:
IOException
-
-
Method Details
-
getChildren
Deprecated.Returns int[] mapping each ordinal to its first child; this is a large array and is computed (and then saved) the first time this method is invoked.- Throws:
IOException
-
getSiblings
Deprecated.Returns int[] mapping each ordinal to its next sibling; this is a large array and is computed (and then saved) the first time this method is invoked.- Throws:
IOException
-
childrenLoaded
public boolean childrenLoaded()Deprecated.Returns true if the (costly, and lazily initialized) children int[] was initialized.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
siblingsLoaded
public boolean siblingsLoaded()Deprecated.Returns true if the (costly, and lazily initialized) sibling int[] was initialized.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
verifyDim
Deprecated.Verifies and returnsFacetsConfig.DimConfig
for the given dimension name.- Returns:
FacetsConfig.DimConfig
for the given dim, orFacetsConfig.DEFAULT_DIM_CONFIG
if it was never manually configured.- Throws:
IllegalArgumentException
- if the provided dimension was manually configured, but itsFacetsConfig.DimConfig.indexFieldName
does not matchindexFieldName
.
-
getAllDims
Deprecated.Description copied from class:Facets
Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.- Specified by:
getAllDims
in classFacets
- Throws:
IOException
-
Facets
implementations. If your code is relying on this, please migrate necessary functionality down into your own class.