public abstract class CategoryTokenizerBase extends TokenFilter
CategoryDocumentBuilder. Contains three
attributes: CategoryAttribute, CharTermAttribute and
PayloadAttribute.AttributeSource.AttributeFactory, AttributeSource.State| Modifier and Type | Field and Description |
|---|---|
protected CategoryAttribute |
categoryAttribute
The stream's category attributes.
|
protected FacetIndexingParams |
indexingParams
Indexing params for creating term text
|
protected Payload |
payload
The object used for constructing payloads.
|
protected PayloadAttribute |
payloadAttribute
The stream's payload attribute.
|
protected CharTermAttribute |
termAttribute
The stream's term attribute.
|
input| Constructor and Description |
|---|
CategoryTokenizerBase(TokenStream input,
FacetIndexingParams indexingParams)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
incrementToken()
Consumers (i.e.,
IndexWriter) use this method to advance the stream to
the next token. |
close, end, resetaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toStringprotected CategoryAttribute categoryAttribute
protected PayloadAttribute payloadAttribute
protected CharTermAttribute termAttribute
protected Payload payload
protected FacetIndexingParams indexingParams
public CategoryTokenizerBase(TokenStream input, FacetIndexingParams indexingParams)
input - The input stream, either CategoryParentsStream or an
extension of CategoryTokenizerBase.indexingParams - The indexing params to use.public abstract boolean incrementToken()
throws IOException
TokenStreamIndexWriter) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpls 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 AttributeImpls 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 TokenStreamIOException