Class CategoryAttributesStream
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.facet.index.streaming.CategoryAttributesStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class CategoryAttributesStream extends org.apache.lucene.analysis.TokenStream
An attribute stream built from anIterable
ofCategoryAttribute
. This stream should then be passed through several filters (seeCategoryParentsStream
,CategoryListTokenizer
andCategoryTokenizer
) until a token stream is produced that can be indexed by Lucene.A CategoryAttributesStream object can be reused for producing more than one stream. To do that, the user should cause the underlying Iterable
object to return a new set of categories, and then call reset()
to allow this stream to be used again.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected CategoryAttribute
categoryAttribute
-
Constructor Summary
Constructors Constructor Description CategoryAttributesStream(Iterable<CategoryAttribute> iterable)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
incrementToken()
void
reset()
-
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
-
-
-
-
Field Detail
-
categoryAttribute
protected CategoryAttribute categoryAttribute
-
-
Constructor Detail
-
CategoryAttributesStream
public CategoryAttributesStream(Iterable<CategoryAttribute> iterable)
Constructor- Parameters:
iterable
-Iterable
ofCategoryAttribute
, from which categories are taken.
-
-
Method Detail
-
incrementToken
public final boolean incrementToken() throws IOException
- Specified by:
incrementToken
in classorg.apache.lucene.analysis.TokenStream
- Throws:
IOException
-
reset
public void reset()
- Overrides:
reset
in classorg.apache.lucene.analysis.TokenStream
-
-