Package org.apache.lucene.tests.analysis
Class LookaheadTokenFilter<T extends LookaheadTokenFilter.Position>
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.tests.analysis.LookaheadTokenFilter<T>
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Unwrappable<TokenStream>
- Direct Known Subclasses:
MockGraphTokenFilter
,MockRandomLookaheadTokenFilter
public abstract class LookaheadTokenFilter<T extends LookaheadTokenFilter.Position>
extends TokenFilter
An abstract TokenFilter to make it easier to build graph token filters requiring some lookahead.
This class handles the details of buffering up tokens, recording them by position, restoring
them, providing access to them, etc.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
Holds all state for a single position; subclass this to record other state at each position.Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected int
protected final OffsetAttribute
protected int
protected final PositionIncrementAttribute
protected final RollingBuffer<T>
protected final PositionLengthAttribute
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
This is called when all input tokens leaving a given position have been returned.protected void
Call this only from within afterPosition, to insert a new token.protected abstract T
protected boolean
Call this when you are done looking ahead; it will set the next token to return.protected boolean
Returns true if there is a new token.void
reset()
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, unwrap
Methods inherited from class org.apache.lucene.analysis.TokenStream
incrementToken
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
-
Field Details
-
posIncAtt
-
posLenAtt
-
offsetAtt
-
inputPos
protected int inputPos -
outputPos
protected int outputPos -
end
protected boolean end -
positions
-
-
Constructor Details
-
LookaheadTokenFilter
-
-
Method Details
-
insertToken
Call this only from within afterPosition, to insert a new token. After calling this you should set any necessary token you need.- Throws:
IOException
-
afterPosition
This is called when all input tokens leaving a given position have been returned. Override this and call insertToken and then set whichever token's attributes you want, if you want to inject a token starting from this position.- Throws:
IOException
-
newPosition
-
peekToken
Returns true if there is a new token.- Throws:
IOException
-
nextToken
Call this when you are done looking ahead; it will set the next token to return. Return the boolean back to the caller.- Throws:
IOException
-
reset
- Overrides:
reset
in classTokenFilter
- Throws:
IOException
-