Class CountingListTokenizer
- 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.index.streaming.CountingListTokenizer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class CountingListTokenizer extends CategoryListTokenizer
CategoryListTokenizer
for facet counting- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected Iterator<Map.Entry<String,CategoryListPayloadStream>>
payloadStreamIterator
An iterator over the payload streamsprotected HashMap<String,CategoryListPayloadStream>
payloadStreamsByName
A table for retrieving payload streams by category-list name.-
Fields inherited from class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
categoryAttribute, indexingParams, payload, payloadAttribute, termAttribute
-
-
Constructor Summary
Constructors Constructor Description CountingListTokenizer(org.apache.lucene.analysis.TokenStream input, FacetIndexingParams indexingParams)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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()
protected boolean
legalCategory()
A method which allows extending classes to filter the categories going into the counting list.-
Methods inherited from class org.apache.lucene.facet.index.streaming.CategoryListTokenizer
handleEndOfInput, 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
-
payloadStreamsByName
protected HashMap<String,CategoryListPayloadStream> payloadStreamsByName
A table for retrieving payload streams by category-list name.
-
payloadStreamIterator
protected Iterator<Map.Entry<String,CategoryListPayloadStream>> payloadStreamIterator
An iterator over the payload streams
-
-
Constructor Detail
-
CountingListTokenizer
public CountingListTokenizer(org.apache.lucene.analysis.TokenStream input, FacetIndexingParams indexingParams)
-
-
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
- Specified by:
incrementToken
in classCategoryListTokenizer
- Throws:
IOException
-
legalCategory
protected boolean legalCategory()
A method which allows extending classes to filter the categories going into the counting list.- Returns:
- By default returns
true
, meaning the current category is to be part of the counting list. For categories that should be filtered, returnfalse
.
-
getPayloadStream
protected CategoryListPayloadStream getPayloadStream(CategoryPath categoryPath, int ordinal) throws IOException
- Throws:
IOException
-
-