Package | Description |
---|---|
org.apache.lucene.facet.associations |
Category Association
|
org.apache.lucene.facet.index |
Indexing of document categories
|
org.apache.lucene.facet.index.categorypolicy |
Policies for indexing categories
|
org.apache.lucene.facet.index.params |
Indexing-time specifications for handling facets
|
org.apache.lucene.facet.search |
Faceted Search API
|
org.apache.lucene.facet.search.params |
Parameters for Faceted Search
|
org.apache.lucene.facet.search.params.associations |
Association-based Parameters for Faceted Search.
|
org.apache.lucene.facet.search.results |
Results of Faceted Search
|
org.apache.lucene.facet.taxonomy |
Taxonomy of Categories
|
org.apache.lucene.facet.taxonomy.directory |
Taxonomy implemented using a Lucene-Index
|
org.apache.lucene.facet.taxonomy.writercache |
Improves indexing time by caching a map of CategoryPath to their Ordinal
|
org.apache.lucene.facet.taxonomy.writercache.cl2o |
Category->Ordinal caching implementation using an optimized data-structures
|
org.apache.lucene.facet.taxonomy.writercache.lru |
An LRU cache implementation for the CategoryPath to Ordinal map
|
Modifier and Type | Method and Description |
---|---|
protected Map<CategoryListParams,Iterable<CategoryPath>> |
AssociationsFacetFields.createCategoryListMapping(Iterable<CategoryPath> categories) |
Iterator<CategoryPath> |
CategoryAssociationsContainer.iterator() |
Modifier and Type | Method and Description |
---|---|
protected void |
AssociationsDrillDownStream.addAdditionalAttributes(CategoryPath cp,
boolean isParent) |
CategoryAssociation |
CategoryAssociationsContainer.getAssociation(CategoryPath category)
|
void |
CategoryAssociationsContainer.setAssociation(CategoryPath category,
CategoryAssociation association)
Adds the
CategoryAssociation for the given category . |
Modifier and Type | Method and Description |
---|---|
void |
AssociationsFacetFields.addFields(Document doc,
Iterable<CategoryPath> categories) |
Map<String,BytesRef> |
AssociationsListBuilder.build(IntsRef ordinals,
Iterable<CategoryPath> categories) |
protected Map<CategoryListParams,Iterable<CategoryPath>> |
AssociationsFacetFields.createCategoryListMapping(Iterable<CategoryPath> categories) |
protected Map<String,BytesRef> |
AssociationsFacetFields.getCategoryListData(CategoryListParams categoryListParams,
IntsRef ordinals,
Iterable<CategoryPath> categories) |
protected DrillDownStream |
AssociationsFacetFields.getDrillDownStream(Iterable<CategoryPath> categories) |
Modifier and Type | Method and Description |
---|---|
protected Map<CategoryListParams,Iterable<CategoryPath>> |
FacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)
Creates a mapping between a
CategoryListParams and all
categories that are associated with it. |
Modifier and Type | Method and Description |
---|---|
protected void |
DrillDownStream.addAdditionalAttributes(CategoryPath category,
boolean isParent) |
Modifier and Type | Method and Description |
---|---|
void |
FacetFields.addFields(Document doc,
Iterable<CategoryPath> categories)
Adds the needed facet fields to the document.
|
Map<String,BytesRef> |
CountingListBuilder.build(IntsRef ordinals,
Iterable<CategoryPath> categories)
Every returned
BytesRef corresponds to a single partition (as
defined by FacetIndexingParams.getPartitionSize() ) and the key
denotes the partition ID. |
Map<String,BytesRef> |
CategoryListBuilder.build(IntsRef ordinals,
Iterable<CategoryPath> categories)
Returns the encoded ordinals data.
|
protected Map<CategoryListParams,Iterable<CategoryPath>> |
FacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)
Creates a mapping between a
CategoryListParams and all
categories that are associated with it. |
protected Map<String,BytesRef> |
FacetFields.getCategoryListData(CategoryListParams categoryListParams,
IntsRef ordinals,
Iterable<CategoryPath> categories)
Returns the category list data, as a mapping from key to
BytesRef
which includes the encoded data. |
protected DrillDownStream |
FacetFields.getDrillDownStream(Iterable<CategoryPath> categories)
Returns a
DrillDownStream for writing the categories drill-down
terms. |
Constructor and Description |
---|
DrillDownStream(Iterable<CategoryPath> categories,
FacetIndexingParams indexingParams) |
Modifier and Type | Method and Description |
---|---|
boolean |
PathPolicy.shouldAdd(CategoryPath categoryPath)
Check whether a given category path should be added to the stream.
|
boolean |
NonTopLevelPathPolicy.shouldAdd(CategoryPath categoryPath)
Filters out (returns false) CategoryPaths equal or less than
TaxonomyReader.ROOT_ORDINAL . |
Modifier and Type | Method and Description |
---|---|
int |
FacetIndexingParams.drillDownTermText(CategoryPath path,
char[] buffer)
Copies the text required to execute a drill-down query on the given
category to the given
char[] , and returns the number of characters
that were written. |
CategoryListParams |
PerDimensionIndexingParams.getCategoryListParams(CategoryPath category)
Returns the
CategoryListParams for the corresponding dimension
which is returned by category.getComponent(0) . |
CategoryListParams |
FacetIndexingParams.getCategoryListParams(CategoryPath category)
Returns the
CategoryListParams for this CategoryPath . |
Constructor and Description |
---|
PerDimensionIndexingParams(Map<CategoryPath,CategoryListParams> paramsMap)
Initializes a new instance with the given dimension-to-params mapping.
|
PerDimensionIndexingParams(Map<CategoryPath,CategoryListParams> paramsMap,
CategoryListParams categoryListParams)
Same as
PerDimensionIndexingParams.PerDimensionIndexingParams(Map) , only the given
CategoryListParams will be used for any dimension that is not
specified in the given mapping. |
Modifier and Type | Method and Description |
---|---|
static Query |
DrillDown.query(FacetIndexingParams iParams,
Query baseQuery,
CategoryPath... paths)
Wraps a given
Query as a drill-down query over the given
categories, assuming all are required (e.g. |
static Query |
DrillDown.query(FacetSearchParams sParams,
Query baseQuery,
CategoryPath... paths) |
static Term |
DrillDown.term(FacetIndexingParams iParams,
CategoryPath path)
Return a drill-down
Term for a category. |
static Term |
DrillDown.term(FacetSearchParams sParams,
CategoryPath path) |
Modifier and Type | Method and Description |
---|---|
CategoryPath |
FacetRequest.getCategoryPath()
The root category of this facet request.
|
Constructor and 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.
|
Constructor and 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.
|
Modifier and Type | Method and Description |
---|---|
CategoryPath |
MutableFacetResultNode.getLabel() |
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 |
MutableFacetResultNode.getLabel(TaxonomyReader taxonomyReader) |
CategoryPath |
FacetResultNode.getLabel(TaxonomyReader taxonomyReader)
Category path of the category of this result.
|
Modifier and Type | Method and Description |
---|---|
void |
MutableFacetResultNode.setLabel(CategoryPath label)
Set the label of the category of this result.
|
Constructor and Description |
---|
MutableFacetResultNode(int ordinal,
double value,
double residue,
CategoryPath label,
List<FacetResultNode> subResults)
Create a Facet Result Node.
|
Modifier and Type | Field and Description |
---|---|
static CategoryPath |
CategoryPath.EMPTY
An empty
CategoryPath |
Modifier and Type | Method and Description |
---|---|
abstract CategoryPath |
TaxonomyReader.getPath(int ordinal)
Returns the path name of the category with the given ordinal.
|
CategoryPath |
CategoryPath.subpath(int length)
Returns a sub-path of this path up to
length components. |
Modifier and Type | Method and 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 path with another
CategoryPath for lexicographic
order. |
abstract int |
TaxonomyReader.getOrdinal(CategoryPath categoryPath)
Returns the ordinal of the category given as a path.
|
Modifier and Type | Method and Description |
---|---|
CategoryPath |
DirectoryTaxonomyReader.getPath(int ordinal) |
Modifier and Type | Method and Description |
---|---|
int |
DirectoryTaxonomyWriter.addCategory(CategoryPath categoryPath) |
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 cp) |
Modifier and Type | Method and 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.
|
boolean |
TaxonomyWriterCache.put(CategoryPath categoryPath,
int ordinal)
Add a category to the cache, with the given ordinal as the value.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
LabelToOrdinal.addLabel(CategoryPath label,
int ordinal)
Adds a new label if its not yet in the table.
|
void |
CompactLabelToOrdinal.addLabel(CategoryPath label,
int ordinal) |
int |
CollisionMap.addLabel(CategoryPath label,
int hash,
int cid) |
int |
Cl2oTaxonomyWriterCache.get(CategoryPath categoryPath) |
int |
CollisionMap.get(CategoryPath label,
int hash) |
abstract int |
LabelToOrdinal.getOrdinal(CategoryPath label) |
int |
CompactLabelToOrdinal.getOrdinal(CategoryPath label) |
boolean |
Cl2oTaxonomyWriterCache.put(CategoryPath categoryPath,
int ordinal) |
Modifier and Type | Method and Description |
---|---|
int |
LruTaxonomyWriterCache.get(CategoryPath categoryPath) |
boolean |
LruTaxonomyWriterCache.put(CategoryPath categoryPath,
int ordinal) |
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.