Uses of Class
org.apache.lucene.facet.taxonomy.FacetLabel
Packages that use FacetLabel
Package
Description
Taxonomy of Categories.
Taxonomy index implementation using on top of a Directory.
Improves indexing time by caching a map of CategoryPath to their Ordinal.
-
Uses of FacetLabel in org.apache.lucene.facet.taxonomy
Methods in org.apache.lucene.facet.taxonomy that return FacetLabelModifier and TypeMethodDescriptionTaxonomyReader.getBulkPath(int... ordinals) Returns the path names of the list of ordinals associated with different categories.abstract FacetLabelTaxonomyReader.getPath(int ordinal) Returns the path name of the category with the given ordinal.TaxonomyFacetLabels.FacetLabelReader.nextFacetLabel(int docId) TaxonomyFacetLabels.FacetLabelReader.nextFacetLabel(int docId, String facetDimension) Retrieves the nextFacetLabelfor the specifieddocIdunder the requestedfacetDimension, ornullif there are no more.FacetLabel.subpath(int length) Returns a sub-path of this path up tolengthcomponents.Methods in org.apache.lucene.facet.taxonomy with parameters of type FacetLabelModifier and TypeMethodDescriptionintTaxonomyWriter.addCategory(FacetLabel categoryPath) addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.intFacetLabel.compareTo(FacetLabel other) Compares this path with anotherFacetLabelfor lexicographic order.int[]TaxonomyReader.getBulkOrdinals(FacetLabel... categoryPath) Returns the ordinals of the categories given as a path.abstract intTaxonomyReader.getOrdinal(FacetLabel categoryPath) Returns the ordinal of the category given as a path. -
Uses of FacetLabel in org.apache.lucene.facet.taxonomy.directory
Methods in org.apache.lucene.facet.taxonomy.directory that return FacetLabelModifier and TypeMethodDescriptionDirectoryTaxonomyReader.getBulkPath(int... ordinals) Returns an array of FacetLabels for a given array of ordinals.DirectoryTaxonomyReader.getPath(int ordinal) Methods in org.apache.lucene.facet.taxonomy.directory with parameters of type FacetLabelModifier and TypeMethodDescriptionintDirectoryTaxonomyWriter.addCategory(FacetLabel categoryPath) protected voidDirectoryTaxonomyWriter.enrichOrdinalDocument(Document d, FacetLabel categoryPath) Child classes can implement this method to modify the document corresponding to a category path before indexing it.protected voidReindexingEnrichedDirectoryTaxonomyWriter.enrichOrdinalDocument(Document d, FacetLabel categoryPath) Add fields specified by theReindexingEnrichedDirectoryTaxonomyWriter.ordinalDataAppenderto the providedDocument.protected intDirectoryTaxonomyWriter.findCategory(FacetLabel categoryPath) Look up the given category in the cache and/or the on-disk storage, returning the category's ordinal, or a negative number in case the category does not yet exist in the taxonomy.int[]DirectoryTaxonomyReader.getBulkOrdinals(FacetLabel... categoryPaths) intDirectoryTaxonomyReader.getOrdinal(FacetLabel cp) Method parameters in org.apache.lucene.facet.taxonomy.directory with type arguments of type FacetLabelModifier and TypeMethodDescriptionvoidReindexingEnrichedDirectoryTaxonomyWriter.reindexWithNewOrdinalData(BiConsumer<FacetLabel, Document> ordinalDataAppender) Delete the existing taxonomy index and recreate it using new ordinal data.Constructor parameters in org.apache.lucene.facet.taxonomy.directory with type arguments of type FacetLabelModifierConstructorDescriptionReindexingEnrichedDirectoryTaxonomyWriter(Directory d, BiConsumer<FacetLabel, Document> ordinalDataAppender) Create a taxonomy writer that will allow editing the ordinal docs before indexing them. -
Uses of FacetLabel in org.apache.lucene.facet.taxonomy.writercache
Methods in org.apache.lucene.facet.taxonomy.writercache with parameters of type FacetLabelModifier and TypeMethodDescriptionabstract voidLabelToOrdinal.addLabel(FacetLabel label, int ordinal) Adds a new label if it is not yet in the table.intLruTaxonomyWriterCache.get(FacetLabel categoryPath) intTaxonomyWriterCache.get(FacetLabel categoryPath) Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.abstract intLabelToOrdinal.getOrdinal(FacetLabel label) Returns the ordinal assigned to the given label, orLabelToOrdinal.INVALID_ORDINALif the label cannot be found in this table.booleanLruTaxonomyWriterCache.put(FacetLabel categoryPath, int ordinal) booleanTaxonomyWriterCache.put(FacetLabel categoryPath, int ordinal) Add a category to the cache, with the given ordinal as the value.