|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
public abstract class TokenFilter
A TokenFilter is a TokenStream whose input is another token stream.
This is an abstract class.
NOTE: subclasses must override
TokenStream.incrementToken()
if the new TokenStream API is used
and TokenStream.next(Token)
or TokenStream.next()
if the old
TokenStream API is used.
See TokenStream
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource |
---|
AttributeSource.AttributeFactory, AttributeSource.State |
Field Summary | |
---|---|
protected TokenStream |
input
The source of tokens for this filter. |
Constructor Summary | |
---|---|
protected |
TokenFilter(TokenStream input)
Construct a token stream filtering the given input. |
Method Summary | |
---|---|
void |
close()
Close the input TokenStream. |
void |
end()
Performs end-of-stream operations, if any, and calls then end() on the
input TokenStream.
NOTE: Be sure to call super.end() first when overriding this method. |
void |
reset()
Reset the filter as well as the input TokenStream. |
Methods inherited from class org.apache.lucene.analysis.TokenStream |
---|
getOnlyUseNewAPI, incrementToken, next, next, setOnlyUseNewAPI |
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 |
Field Detail |
---|
protected final TokenStream input
Constructor Detail |
---|
protected TokenFilter(TokenStream input)
Method Detail |
---|
public void end() throws IOException
end()
on the
input TokenStream.
NOTE: Be sure to call super.end()
first when overriding this method.
end
in class TokenStream
IOException
public void close() throws IOException
close
in class TokenStream
IOException
public void reset() throws IOException
reset
in class TokenStream
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |