Class CategoryTokenizer

  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.TokenFilter
              extended by org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
                  extended by org.apache.lucene.facet.index.streaming.CategoryTokenizer
All Implemented Interfaces:
Direct Known Subclasses:

public class CategoryTokenizer
extends CategoryTokenizerBase

Basic class for setting the CharTermAttributes and PayloadAttributes of category tokens.

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 inherited from class org.apache.lucene.facet.index.streaming.CategoryTokenizerBase
categoryAttribute, indexingParams, payload, payloadAttribute, termAttribute
Fields inherited from class org.apache.lucene.analysis.TokenFilter
Constructor Summary
CategoryTokenizer(TokenStream input, FacetIndexingParams indexingParams)
Method Summary
 boolean incrementToken()
          Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
protected  void setPayload()
          Set the payload of the current category token.
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, 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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail


public CategoryTokenizer(TokenStream input,
                         FacetIndexingParams indexingParams)
See Also:
CategoryTokenizerBase.CategoryTokenizerBase(TokenStream, FacetIndexingParams)
Method Detail


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 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().

Specified by:
incrementToken in class CategoryTokenizerBase
false for end of stream; true otherwise


protected void setPayload()
Set the payload of the current category token.

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.