Class AssociationListTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
-
- org.apache.lucene.facet.index.streaming.CategoryListTokenizer
-
- org.apache.lucene.facet.enhancements.association.AssociationListTokenizer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class AssociationListTokenizer extends CategoryListTokenizer
Tokenizer for associations of a category- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description protected CategoryListPayloadStream
payloadStream
-
Fields inherited from class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
categoryAttribute, indexingParams, payload, payloadAttribute, termAttribute
-
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
-
-
Constructor Summary
Constructors Constructor Description AssociationListTokenizer(TokenStream input, EnhancementsIndexingParams indexingParams, CategoryEnhancement enhancement)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
handleStartOfInput()
A method invoked once when the input stream begins, for subclass-specific processing.boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.-
Methods inherited from class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
handleEndOfInput, reset
-
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end
-
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
-
payloadStream
protected CategoryListPayloadStream payloadStream
-
-
Constructor Detail
-
AssociationListTokenizer
public AssociationListTokenizer(TokenStream input, EnhancementsIndexingParams indexingParams, CategoryEnhancement enhancement)
-
-
Method Detail
-
handleStartOfInput
protected void handleStartOfInput() throws IOException
Description copied from class:CategoryListTokenizer
A method invoked once when the input stream begins, for subclass-specific processing. Subclass implementations must invoke this one, too!- Overrides:
handleStartOfInput
in classCategoryListTokenizer
- Throws:
IOException
-
incrementToken
public final boolean incrementToken() throws IOException
Description copied from class:TokenStream
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriateAttributeImpl
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)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
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()
.- Specified by:
incrementToken
in classCategoryListTokenizer
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
-