|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.miscellaneous.PrefixAwareTokenFilter
public class PrefixAwareTokenFilter
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.
Constructor Summary | |
---|---|
PrefixAwareTokenFilter(TokenStream prefix,
TokenStream suffix)
|
Method Summary | |
---|---|
void |
close()
Releases resources associated with this stream. |
TokenStream |
getPrefix()
|
TokenStream |
getSuffix()
|
Token |
next(Token reusableToken)
Returns the next token in the stream, or null at EOS. |
void |
reset()
Resets this stream to the beginning. |
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.analysis.TokenStream |
---|
next |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrefixAwareTokenFilter(TokenStream prefix, TokenStream suffix)
Method Detail |
---|
public Token next(Token reusableToken) throws IOException
TokenStream
This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):
Token.clear()
before setting the fields in it & returning itTokenFilter
is considered a consumer.
next
in class TokenStream
reusableToken
- a Token that may or may not be used to
return; this parameter should never be null (the callee
is not required to check for null before using it, but it is a
good idea to assert that it is not null.)
IOException
public Token updateSuffixToken(Token suffixToken, Token lastPrefixToken)
suffixToken
- a token from the suffix streamlastPrefixToken
- the last token from the prefix stream
public void close() throws IOException
TokenStream
close
in class TokenStream
IOException
public void reset() throws IOException
TokenStream
reset
in class TokenStream
IOException
public TokenStream getPrefix()
public void setPrefix(TokenStream prefix)
public TokenStream getSuffix()
public void setSuffix(TokenStream suffix)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |