public class CategoryParentsStream
extends org.apache.lucene.analysis.TokenFilter
CategoryAttributesStream
. The parents
are added according to the PathPolicy
and OrdinalPolicy
from
the FacetIndexingParams
given in the constructor.addRetainableProperty(Class)
.Modifier and Type | Field and Description |
---|---|
protected CategoryAttribute |
categoryAttribute
An attribute containing all data related to the category
|
protected OrdinalProperty |
ordinalProperty
A category property containing the category ordinal
|
protected TaxonomyWriter |
taxonomyWriter
A
TaxonomyWriter for adding categories and retrieving their
ordinals. |
Constructor and Description |
---|
CategoryParentsStream(CategoryAttributesStream input,
TaxonomyWriter taxonomyWriter,
FacetIndexingParams indexingParams)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addRetainableProperty(Class<? extends CategoryProperty> toRetain)
Add a
CategoryProperty class which is retained when creating
parent tokens. |
protected void |
clearCategoryProperties()
Clear the properties of the current
CategoryAttribute attribute
before setting the parent attributes. |
boolean |
incrementToken() |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
protected TaxonomyWriter taxonomyWriter
TaxonomyWriter
for adding categories and retrieving their
ordinals.protected CategoryAttribute categoryAttribute
protected OrdinalProperty ordinalProperty
public CategoryParentsStream(CategoryAttributesStream input, TaxonomyWriter taxonomyWriter, FacetIndexingParams indexingParams)
input
- The input stream to handle, must be derived from
CategoryAttributesStream
.taxonomyWriter
- The taxonomy writer to use for adding categories and
retrieving their ordinals.indexingParams
- The indexing params used for filtering parents.public final boolean incrementToken() throws IOException
incrementToken
in class org.apache.lucene.analysis.TokenStream
IOException
protected void clearCategoryProperties()
CategoryAttribute
attribute
before setting the parent attributes. addRetainableProperty(Class)
.public void addRetainableProperty(Class<? extends CategoryProperty> toRetain)
CategoryProperty
class which is retained when creating
parent tokens.toRetain
- The property class to retain.