org.apache.lucene.analysis
Class TeeSinkTokenFilter.SinkTokenStream
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TeeSinkTokenFilter.SinkTokenStream
- Enclosing class:
- TeeSinkTokenFilter
public static final class TeeSinkTokenFilter.SinkTokenStream
- extends TokenStream
Method Summary |
void |
end()
This method is called by the consumer after the last token has been
consumed, after TokenStream.incrementToken() returned false
(using the new TokenStream API). |
boolean |
incrementToken()
Consumers (ie IndexWriter ) use this method to advance the stream to
the next token. |
void |
reset()
Resets this stream to the beginning. |
Methods inherited from class org.apache.lucene.util.AttributeSource |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString |
incrementToken
public final boolean incrementToken()
throws IOException
- Description copied from class:
TokenStream
- Consumers (ie
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
s with the attributes of the next
token.
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)
or downcasts,
references to all AttributeImpl
s 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()
.
- Overrides:
incrementToken
in class TokenStream
- Returns:
- false for end of stream; true otherwise
Note that this method will be defined abstract in Lucene
3.0.
- Throws:
IOException
end
public final void end()
throws IOException
- Description copied from class:
TokenStream
- This method is called by the consumer after the last token has been
consumed, after
TokenStream.incrementToken()
returned false
(using the new TokenStream
API). Streams implementing the old API
should upgrade to use this feature.
This method can be used to perform any end-of-stream operations, such as
setting the final offset of a stream. The final offset of a stream might
differ from the offset of the last token eg in case one or more whitespaces
followed after the last token, but a WhitespaceTokenizer
was used.
- Overrides:
end
in class TokenStream
- Throws:
IOException
reset
public final void reset()
- 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()
).
- Overrides:
reset
in class TokenStream
Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.