org.apache.lucene.analysis.miscellaneous
Class PrefixAwareTokenFilter

java.lang.Object
  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.miscellaneous.PrefixAwareTokenFilter
All Implemented Interfaces:
Closeable

public class PrefixAwareTokenFilter
extends TokenStream

Joins two token streams and leaves the last token of the first stream available to be used when updating the token values in the second stream based on that token. The default implementation adds last prefix token end offset to the suffix token start and end offsets.

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
PrefixAwareTokenFilter(TokenStream prefix, TokenStream suffix)
           
 
Method Summary
 void close()
           
 void end()
           
 TokenStream getPrefix()
           
 TokenStream getSuffix()
           
 boolean incrementToken()
           
 void reset()
           
 void setPrefix(TokenStream prefix)
           
 void setSuffix(TokenStream suffix)
           
 Token updateSuffixToken(Token suffixToken, Token lastPrefixToken)
          The default implementation adds last prefix token end offset to the suffix token start and end offsets.
 
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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrefixAwareTokenFilter

public PrefixAwareTokenFilter(TokenStream prefix,
                              TokenStream suffix)
Method Detail

incrementToken

public final boolean incrementToken()
                             throws IOException
Specified by:
incrementToken in class TokenStream
Throws:
IOException

updateSuffixToken

public Token updateSuffixToken(Token suffixToken,
                               Token lastPrefixToken)
The default implementation adds last prefix token end offset to the suffix token start and end offsets.

Parameters:
suffixToken - a token from the suffix stream
lastPrefixToken - the last token from the prefix stream
Returns:
consumer token

end

public void end()
         throws IOException
Overrides:
end in class TokenStream
Throws:
IOException

close

public void close()
           throws IOException
Specified by:
close in interface Closeable
Overrides:
close in class TokenStream
Throws:
IOException

reset

public void reset()
           throws IOException
Overrides:
reset in class TokenStream
Throws:
IOException

getPrefix

public TokenStream getPrefix()

setPrefix

public void setPrefix(TokenStream prefix)

getSuffix

public TokenStream getSuffix()

setSuffix

public void setSuffix(TokenStream suffix)


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