Uses of Class
org.apache.lucene.facet.taxonomy.CategoryPath
-
Packages that use CategoryPath Package Description org.apache.lucene.facet.index Indexing of document categoriesorg.apache.lucene.facet.index.attributes Category attributes and their properties for indexingorg.apache.lucene.facet.index.categorypolicy Policies for indexing categoriesorg.apache.lucene.facet.index.params Indexing-time specifications for handling facetsorg.apache.lucene.facet.index.streaming Expert: attributes streaming definition for indexing facetsorg.apache.lucene.facet.search Faceted Search APIorg.apache.lucene.facet.search.params Parameters for Faceted Searchorg.apache.lucene.facet.search.params.association Association-based Parameters for Faceted Search.org.apache.lucene.facet.search.results Results of Faceted Searchorg.apache.lucene.facet.taxonomy Taxonomy of Categoriesorg.apache.lucene.facet.taxonomy.directory Taxonomy implemented using a Lucene-Indexorg.apache.lucene.facet.taxonomy.writercache Improves indexing time by caching a map of CategoryPath to their Ordinalorg.apache.lucene.facet.taxonomy.writercache.cl2o Category->Ordinal caching implementation using an optimized data-structuresorg.apache.lucene.facet.taxonomy.writercache.lru An LRU cache implementation for the CategoryPath to Ordinal map -
-
Uses of CategoryPath in org.apache.lucene.facet.index
Fields in org.apache.lucene.facet.index with type parameters of type CategoryPath Modifier and Type Field Description protected Map<CategoryPath,CategoryAttribute>
CategoryContainer. map
Methods in org.apache.lucene.facet.index with parameters of type CategoryPath Modifier and Type Method Description CategoryAttribute
CategoryContainer. addCategory(CategoryPath categoryPath)
Add a category.CategoryAttribute
CategoryContainer. addCategory(CategoryPath categoryPath, CategoryProperty property)
Add a category with a property.CategoryAttribute
CategoryContainer. addCategory(CategoryPath categoryPath, CategoryProperty... properties)
Add a category with multiple properties.CategoryAttribute
CategoryContainer. getCategoryAttribute(CategoryPath categoryPath)
Get theCategoryAttribute
this container has for a certain category, ornull
if the category is not in the container.Method parameters in org.apache.lucene.facet.index with type arguments of type CategoryPath Modifier and Type Method Description CategoryDocumentBuilder
CategoryDocumentBuilder. setCategoryPaths(Iterable<CategoryPath> categoryPaths)
Set the categories of the document builder from anIterable
ofCategoryPath
objects. -
Uses of CategoryPath in org.apache.lucene.facet.index.attributes
Fields in org.apache.lucene.facet.index.attributes declared as CategoryPath Modifier and Type Field Description protected CategoryPath
CategoryAttributeImpl. categoryPath
The category path instance.Methods in org.apache.lucene.facet.index.attributes that return CategoryPath Modifier and Type Method Description CategoryPath
CategoryAttribute. getCategoryPath()
Returns the value of this attribute: a category path.CategoryPath
CategoryAttributeImpl. getCategoryPath()
Returns the category path value.Methods in org.apache.lucene.facet.index.attributes with parameters of type CategoryPath Modifier and Type Method Description void
CategoryAttribute. setCategoryPath(CategoryPath cp)
Sets the category path value of this attribute.void
CategoryAttributeImpl. setCategoryPath(CategoryPath cp)
Constructors in org.apache.lucene.facet.index.attributes with parameters of type CategoryPath Constructor Description CategoryAttributeImpl(CategoryPath categoryPath)
Construct a CategoryAttributeImpl with the given CategoryPath.Constructor parameters in org.apache.lucene.facet.index.attributes with type arguments of type CategoryPath Constructor Description CategoryAttributesIterable(Iterable<CategoryPath> inputIterable)
-
Uses of CategoryPath in org.apache.lucene.facet.index.categorypolicy
Methods in org.apache.lucene.facet.index.categorypolicy with parameters of type CategoryPath Modifier and Type Method Description boolean
DefaultPathPolicy. shouldAdd(CategoryPath categoryPath)
Filters out (returns false) CategoryPaths equal or less thanTaxonomyReader.ROOT_ORDINAL
.boolean
NonTopLevelPathPolicy. shouldAdd(CategoryPath categoryPath)
Filters out (returns false) CategoryPaths equal or less thanTaxonomyReader.ROOT_ORDINAL
.boolean
PathPolicy. shouldAdd(CategoryPath categoryPath)
Check whether a given category path should be added to the stream. -
Uses of CategoryPath in org.apache.lucene.facet.index.params
Methods in org.apache.lucene.facet.index.params with parameters of type CategoryPath Modifier and Type Method Description void
PerDimensionIndexingParams. addCategoryListParams(CategoryPath category, CategoryListParams clParams)
Add a CategoryListParams for a given CategoryPath's dimension or "zero-th" category.int
DefaultFacetIndexingParams. drillDownTermText(CategoryPath path, char[] buffer)
int
FacetIndexingParams. drillDownTermText(CategoryPath path, char[] buffer)
Return the drilldown Term-Text which does not need to do any allocations.CategoryListParams
DefaultFacetIndexingParams. getCategoryListParams(CategoryPath category)
CategoryListParams
FacetIndexingParams. getCategoryListParams(CategoryPath category)
The name of the category-list to put this category in, or null if this category should not be aggregatable.CategoryListParams
PerDimensionIndexingParams. getCategoryListParams(CategoryPath category)
Get the CategoryListParams based on the dimension or "zero-th category" of the specified CategoryPath. -
Uses of CategoryPath in org.apache.lucene.facet.index.streaming
Methods in org.apache.lucene.facet.index.streaming with parameters of type CategoryPath Modifier and Type Method Description protected CategoryListPayloadStream
CountingListTokenizer. getPayloadStream(CategoryPath categoryPath, int ordinal)
-
Uses of CategoryPath in org.apache.lucene.facet.search
Methods in org.apache.lucene.facet.search with parameters of type CategoryPath Modifier and Type Method Description static Query
DrillDown. query(FacetIndexingParams iParams, CategoryPath... paths)
Return a query for drilling down into all given categories (AND).static Query
DrillDown. query(FacetIndexingParams iParams, Query baseQuery, CategoryPath... paths)
Turn a base query into a drilling-down query for all given category paths (AND).static Query
DrillDown. query(FacetSearchParams sParams, CategoryPath... paths)
Return a query for drilling down into all given categories (AND).static Query
DrillDown. query(FacetSearchParams sParams, Query baseQuery, CategoryPath... paths)
Turn a base query into a drilling-down query for all given category paths (AND).static Query
DrillDown. query(Query baseQuery, CategoryPath... paths)
Turn a base query into a drilling-down query using the defaultFacetSearchParams
static Term
DrillDown. term(FacetIndexingParams iParams, CategoryPath path)
Return a term for drilling down into a category.static Term
DrillDown. term(FacetSearchParams sParams, CategoryPath path)
-
Uses of CategoryPath in org.apache.lucene.facet.search.params
Methods in org.apache.lucene.facet.search.params that return CategoryPath Modifier and Type Method Description CategoryPath
FacetRequest. getCategoryPath()
The root category of this facet request.Constructors in org.apache.lucene.facet.search.params with parameters of type CategoryPath Constructor Description CountFacetRequest(CategoryPath path, int num)
Create a count facet request for a given node in the taxonomy.FacetRequest(CategoryPath path, int numResults)
Initialize the request with a given path, and a requested number of facets results.ScoreFacetRequest(CategoryPath path, int num)
Create a score facet request for a given node in the taxonomy. -
Uses of CategoryPath in org.apache.lucene.facet.search.params.association
Constructors in org.apache.lucene.facet.search.params.association with parameters of type CategoryPath Constructor Description AssociationFloatSumFacetRequest(CategoryPath path, int num)
Create a float association facet request for a given node in the taxonomy.AssociationIntSumFacetRequest(CategoryPath path, int num)
Create an integer association facet request for a given node in the taxonomy. -
Uses of CategoryPath in org.apache.lucene.facet.search.results
Methods in org.apache.lucene.facet.search.results that return CategoryPath Modifier and Type Method Description CategoryPath
FacetResultNode. getLabel()
Category path of the category of this result, or null if not computed, because the application did not request to compute it.CategoryPath
FacetResultNode. getLabel(TaxonomyReader taxonomyReader)
Category path of the category of this result.CategoryPath
MutableFacetResultNode. getLabel()
CategoryPath
MutableFacetResultNode. getLabel(TaxonomyReader taxonomyReader)
Methods in org.apache.lucene.facet.search.results with parameters of type CategoryPath Modifier and Type Method Description void
MutableFacetResultNode. setLabel(CategoryPath label)
Set the label of the category of this result.Constructors in org.apache.lucene.facet.search.results with parameters of type CategoryPath Constructor Description MutableFacetResultNode(int ordinal, double value, double residue, CategoryPath label, List<FacetResultNode> subResults)
Create a Facet Result Node. -
Uses of CategoryPath in org.apache.lucene.facet.taxonomy
Methods in org.apache.lucene.facet.taxonomy that return CategoryPath Modifier and Type Method Description CategoryPath
TaxonomyReader. getPath(int ordinal)
getPath() returns the path name of the category with the given ordinal.Methods in org.apache.lucene.facet.taxonomy with parameters of type CategoryPath Modifier and Type Method Description int
TaxonomyWriter. addCategory(CategoryPath categoryPath)
addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.int
CategoryPath. compareTo(CategoryPath other)
Compares this CategoryPath with the other CategoryPath for lexicographic order.int
TaxonomyReader. getOrdinal(CategoryPath categoryPath)
getOrdinal() returns the ordinal of the category given as a path.boolean
TaxonomyReader. getPath(int ordinal, CategoryPath result)
getPath() returns the path name of the category with the given ordinal.boolean
CategoryPath. isDescendantOf(CategoryPath other)
Test whether this object is a descendant of another CategoryPath.Constructors in org.apache.lucene.facet.taxonomy with parameters of type CategoryPath Constructor Description CategoryPath(CategoryPath existing)
Construct a new CategoryPath object, copying the path given in an existing CategoryPath object.CategoryPath(CategoryPath existing, int prefixLen)
Construct a new CategoryPath object, copying a prefix with the given number of components of the path given in an existing CategoryPath object. -
Uses of CategoryPath in org.apache.lucene.facet.taxonomy.directory
Methods in org.apache.lucene.facet.taxonomy.directory that return CategoryPath Modifier and Type Method Description CategoryPath
DirectoryTaxonomyReader. getPath(int ordinal)
Methods in org.apache.lucene.facet.taxonomy.directory with parameters of type CategoryPath Modifier and Type Method Description int
DirectoryTaxonomyWriter. addCategory(CategoryPath categoryPath)
protected int
DirectoryTaxonomyWriter. addCategoryDocument(CategoryPath categoryPath, int length, int parent)
protected int
DirectoryTaxonomyWriter. findCategory(CategoryPath 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. getOrdinal(CategoryPath categoryPath)
boolean
DirectoryTaxonomyReader. getPath(int ordinal, CategoryPath result)
-
Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache
Methods in org.apache.lucene.facet.taxonomy.writercache with parameters of type CategoryPath Modifier and Type Method Description int
TaxonomyWriterCache. get(CategoryPath categoryPath)
Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.int
TaxonomyWriterCache. get(CategoryPath categoryPath, int length)
LikeTaxonomyWriterCache.get(CategoryPath)
, but for a given prefix of the category path.boolean
TaxonomyWriterCache. put(CategoryPath categoryPath, int ordinal)
Add a category to the cache, with the given ordinal as the value.boolean
TaxonomyWriterCache. put(CategoryPath categoryPath, int prefixLen, int ordinal)
LikeTaxonomyWriterCache.put(CategoryPath, int)
, but for a given prefix of the category path. -
Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache.cl2o
Methods in org.apache.lucene.facet.taxonomy.writercache.cl2o with parameters of type CategoryPath Modifier and Type Method Description int
CollisionMap. addLabel(CategoryPath label, int hash, int cid)
int
CollisionMap. addLabel(CategoryPath label, int prefixLen, int hash, int cid)
void
CompactLabelToOrdinal. addLabel(CategoryPath label, int ordinal)
void
CompactLabelToOrdinal. addLabel(CategoryPath label, int prefixLen, int ordinal)
abstract void
LabelToOrdinal. addLabel(CategoryPath label, int ordinal)
Adds a new label if its not yet in the table.abstract void
LabelToOrdinal. addLabel(CategoryPath label, int prefixLen, int ordinal)
Adds a new label if its not yet in the table.int
Cl2oTaxonomyWriterCache. get(CategoryPath categoryPath)
int
Cl2oTaxonomyWriterCache. get(CategoryPath categoryPath, int length)
int
CollisionMap. get(CategoryPath label, int hash)
int
CollisionMap. get(CategoryPath label, int prefixLen, int hash)
int
CompactLabelToOrdinal. getOrdinal(CategoryPath label)
int
CompactLabelToOrdinal. getOrdinal(CategoryPath label, int prefixLen)
abstract int
LabelToOrdinal. getOrdinal(CategoryPath label)
abstract int
LabelToOrdinal. getOrdinal(CategoryPath label, int prefixLen)
boolean
Cl2oTaxonomyWriterCache. put(CategoryPath categoryPath, int ordinal)
boolean
Cl2oTaxonomyWriterCache. put(CategoryPath categoryPath, int prefixLen, int ordinal)
-
Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache.lru
Methods in org.apache.lucene.facet.taxonomy.writercache.lru with parameters of type CategoryPath Modifier and Type Method Description int
LruTaxonomyWriterCache. get(CategoryPath categoryPath)
int
LruTaxonomyWriterCache. get(CategoryPath categoryPath, int length)
boolean
LruTaxonomyWriterCache. put(CategoryPath categoryPath, int ordinal)
boolean
LruTaxonomyWriterCache. put(CategoryPath categoryPath, int prefixLen, int ordinal)
-