Class EnhancementsDocumentBuilder
- java.lang.Object
-
- org.apache.lucene.facet.index.CategoryDocumentBuilder
-
- org.apache.lucene.facet.enhancements.EnhancementsDocumentBuilder
-
public class EnhancementsDocumentBuilder extends CategoryDocumentBuilder
AnEnhancementsDocumentBuilder
is aCategoryDocumentBuilder
which adds categories to documents according to the list ofCategoryEnhancement
s fromEnhancementsIndexingParams
. The additions overCategoryDocumentBuilder
could be in both category tokens, and additional category lists.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.facet.index.CategoryDocumentBuilder
categoriesMap, fieldList, indexingParams, taxonomyWriter
-
-
Constructor Summary
Constructors Constructor Description EnhancementsDocumentBuilder(TaxonomyWriter taxonomyWriter, EnhancementsIndexingParams params)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CategoryListTokenizer
getCategoryListTokenizer(org.apache.lucene.analysis.TokenStream categoryStream)
Get a category list tokenizer (or a series of such tokenizers) to create the category list tokens.protected CategoryTokenizer
getCategoryTokenizer(org.apache.lucene.analysis.TokenStream categoryStream)
Get aCategoryTokenizer
to create the category tokens.protected org.apache.lucene.analysis.TokenStream
getParentsStream(CategoryAttributesStream categoryAttributesStream)
Get a stream of categories which includes the parents, according to policies defined in indexing parameters.-
Methods inherited from class org.apache.lucene.facet.index.CategoryDocumentBuilder
build, fillCategoriesMap, getCountingListTokenizer, setCategories, setCategoryPaths
-
-
-
-
Constructor Detail
-
EnhancementsDocumentBuilder
public EnhancementsDocumentBuilder(TaxonomyWriter taxonomyWriter, EnhancementsIndexingParams params) throws IOException
- Parameters:
taxonomyWriter
-params
- Indexing params which includeCategoryEnhancement
s.- Throws:
IOException
-
-
Method Detail
-
getParentsStream
protected org.apache.lucene.analysis.TokenStream getParentsStream(CategoryAttributesStream categoryAttributesStream)
Description copied from class:CategoryDocumentBuilder
Get a stream of categories which includes the parents, according to policies defined in indexing parameters.- Overrides:
getParentsStream
in classCategoryDocumentBuilder
- Parameters:
categoryAttributesStream
- The input stream- Returns:
- The parents stream.
- See Also:
OrdinalPolicy (for policy of adding category tokens for parents)
,PathPolicy (for policy of adding category list tokens for parents)
-
getCategoryListTokenizer
protected CategoryListTokenizer getCategoryListTokenizer(org.apache.lucene.analysis.TokenStream categoryStream)
Description copied from class:CategoryDocumentBuilder
Get a category list tokenizer (or a series of such tokenizers) to create the category list tokens.- Overrides:
getCategoryListTokenizer
in classCategoryDocumentBuilder
- Parameters:
categoryStream
- A stream containingCategoryAttribute
with the relevant data.- Returns:
- The category list tokenizer (or series of tokenizers) to be used in creating category list tokens.
-
getCategoryTokenizer
protected CategoryTokenizer getCategoryTokenizer(org.apache.lucene.analysis.TokenStream categoryStream) throws IOException
Description copied from class:CategoryDocumentBuilder
Get aCategoryTokenizer
to create the category tokens. This method can be overridden for adding more attributes to the category tokens.- Overrides:
getCategoryTokenizer
in classCategoryDocumentBuilder
- Parameters:
categoryStream
- A stream containingCategoryAttribute
with the relevant data.- Returns:
- The
CategoryTokenizer
to be used in creating category tokens. - Throws:
IOException
-
-