public class CountingListTokenizer extends CategoryListTokenizer
CategoryListTokenizer for facet countingAttributeSource.AttributeFactory, AttributeSource.State| Modifier and Type | Field and Description |
|---|---|
protected Iterator<Map.Entry<String,CategoryListPayloadStream>> |
payloadStreamIterator
An iterator over the payload streams
|
protected HashMap<String,CategoryListPayloadStream> |
payloadStreamsByName
A table for retrieving payload streams by category-list name.
|
categoryAttribute, indexingParams, payload, payloadAttribute, termAttributeinput| Constructor and Description |
|---|
CountingListTokenizer(TokenStream input,
FacetIndexingParams indexingParams) |
| Modifier and Type | Method and Description |
|---|---|
protected CategoryListPayloadStream |
getPayloadStream(CategoryPath categoryPath,
int ordinal) |
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. |
protected boolean |
legalCategory()
A method which allows extending classes to filter the categories going
into the counting list.
|
handleEndOfInput, resetclose, endaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toStringprotected HashMap<String,CategoryListPayloadStream> payloadStreamsByName
protected Iterator<Map.Entry<String,CategoryListPayloadStream>> payloadStreamIterator
public CountingListTokenizer(TokenStream input, FacetIndexingParams indexingParams)
protected void handleStartOfInput()
throws IOException
CategoryListTokenizerhandleStartOfInput in class CategoryListTokenizerIOExceptionpublic final 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 CategoryListTokenizerIOExceptionprotected boolean legalCategory()
true, meaning the current category is
to be part of the counting list. For categories that should be
filtered, return false.protected CategoryListPayloadStream getPayloadStream(CategoryPath categoryPath, int ordinal) throws IOException
IOException