Class PrefixAndSuffixAwareTokenFilter

  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.miscellaneous.PrefixAndSuffixAwareTokenFilter
All Implemented Interfaces:

public class PrefixAndSuffixAwareTokenFilter
extends TokenStream

Links two PrefixAwareTokenFilter.

NOTE: This filter might not behave correctly if used with custom Attributes, i.e. Attributes other than the ones located in org.apache.lucene.analysis.tokenattributes.

Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
Constructor Summary
PrefixAndSuffixAwareTokenFilter(TokenStream prefix, TokenStream input, TokenStream suffix)
Method Summary
 void close()
          Releases resources associated with this stream.
 boolean incrementToken()
          Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
 void reset()
          Resets this stream to the beginning.
 Token updateInputToken(Token inputToken, Token lastPrefixToken)
 Token updateSuffixToken(Token suffixToken, Token lastInputToken)
Methods inherited from class org.apache.lucene.analysis.TokenStream
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail


public PrefixAndSuffixAwareTokenFilter(TokenStream prefix,
                                       TokenStream input,
                                       TokenStream suffix)
Method Detail


public Token updateInputToken(Token inputToken,
                              Token lastPrefixToken)


public Token updateSuffixToken(Token suffixToken,
                               Token lastInputToken)


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 TokenStream
false for end of stream; true otherwise


public void reset()
           throws IOException
Description copied from class: TokenStream
Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method. TokenStream.reset() is not needed for the standard indexing process. However, if the tokens of a TokenStream are intended to be consumed more than once, it is necessary to implement TokenStream.reset(). Note that if your TokenStream caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes after TokenStream.reset()).

reset in class TokenStream


public void close()
           throws IOException
Description copied from class: TokenStream
Releases resources associated with this stream.

Specified by:
close in interface Closeable
close in class TokenStream

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