public class CategoryParentsStream extends TokenFilter
CategoryAttributesStream
. The parents
are added according to the PathPolicy
and OrdinalPolicy
from
the FacetIndexingParams
given in the constructor.addRetainableProperty(Class)
.AttributeSource.AttributeFactory, AttributeSource.State
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. |
input
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()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
close, end, reset
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
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
s with the attributes of the next
token.
The producer must make no assumptions about the attributes after the method
has been returned: the caller may arbitrarily change it. If the producer
needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.
This method is called for every token of a document, so an efficient
implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
s that this stream uses should be
retrieved during instantiation.
To ensure that filters and consumers know which attributes are available,
the attributes must be added during instantiation. Filters and consumers
are not required to check for availability of attributes in
TokenStream.incrementToken()
.
incrementToken
in class 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.