public class TokenOffsetPayloadTokenFilter extends TokenFilter
Token.setStartOffset(int)
and Token.setEndOffset(int)
First 4 bytes are the startAttributeSource.AttributeFactory, AttributeSource.State| Modifier and Type | Field and Description |
|---|---|
protected OffsetAttribute |
offsetAtt |
protected PayloadAttribute |
payAtt |
input| Constructor and Description |
|---|
TokenOffsetPayloadTokenFilter(TokenStream input) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter) use this method to advance the stream to
the next token. |
Token |
next()
Deprecated.
Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer.
|
Token |
next(Token reusableToken)
Deprecated.
Will be removed in Lucene 3.0. This method is final, as it should
not be overridden. Delegates to the backwards compatibility layer.
|
close, end, resetgetOnlyUseNewAPI, setOnlyUseNewAPIaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toStringprotected OffsetAttribute offsetAtt
protected PayloadAttribute payAtt
public TokenOffsetPayloadTokenFilter(TokenStream input)
public final boolean incrementToken()
throws java.io.IOException
TokenStreamIndexWriter) 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) or downcasts,
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().
incrementToken in class TokenStreamNote that this method will be defined abstract in Lucene 3.0.
java.io.IOExceptionpublic final Token next(Token reusableToken) throws java.io.IOException
TokenStreamThis implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):
Token
before calling this method again.Token.clear() before setting the fields in
it and returning itToken after it
has been returned: the caller may arbitrarily change it. If the producer
needs to hold onto the Token for subsequent calls, it must clone()
it before storing it. Note that a TokenFilter is considered a
consumer.next in class TokenStreamreusableToken - 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.)Token in the stream or null if end-of-stream was hitjava.io.IOExceptionpublic final Token next() throws java.io.IOException
TokenStreamToken in the stream, or null at EOS.next in class TokenStreamjava.io.IOExceptionCopyright © 2000-2016 Apache Software Foundation. All Rights Reserved.