Class SimplePatternSplitTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.Tokenizer
-
- org.apache.lucene.analysis.pattern.SimplePatternSplitTokenizer
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public final class SimplePatternSplitTokenizer extends Tokenizer
This tokenizer uses a LuceneRegExp
or (expert usage) a pre-built determinizedAutomaton
, to locate tokens. The regexp syntax is more limited thanPatternTokenizer
, but the tokenization is quite a bit faster. This is just likeSimplePatternTokenizer
except that the pattern should make valid token separator characters, likeString.split
. Empty string tokens are never produced.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description private char[]
buffer
private int
bufferLimit
private int
bufferNextRead
private int
offset
private OffsetAttribute
offsetAtt
private char[]
pendingChars
private int
pendingLimit
private int
pendingUpto
private CharacterRunAutomaton
runDFA
private int
sepUpto
private CharTermAttribute
termAtt
private int
tokenUpto
-
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
-
Constructor Summary
Constructors Constructor Description SimplePatternSplitTokenizer(java.lang.String regexp)
SeeRegExp
for the accepted syntax.SimplePatternSplitTokenizer(AttributeFactory factory, java.lang.String regexp, int determinizeWorkLimit)
SeeRegExp
for the accepted syntax.SimplePatternSplitTokenizer(AttributeFactory factory, Automaton dfa)
Runs a pre-built automaton.SimplePatternSplitTokenizer(Automaton dfa)
Runs a pre-built automaton.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
appendToToken(char ch)
void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).private void
fillToken(int offsetStart)
boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.private int
nextCodePoint()
private int
nextCodeUnit()
private void
pushBack(int count)
Pushes back the lastcount
characters in current token's buffer.void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.-
Methods inherited from class org.apache.lucene.analysis.Tokenizer
close, correctOffset, setReader, setReaderTestPoint
-
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 Detail
-
termAtt
private final CharTermAttribute termAtt
-
offsetAtt
private final OffsetAttribute offsetAtt
-
runDFA
private final CharacterRunAutomaton runDFA
-
pendingChars
private char[] pendingChars
-
tokenUpto
private int tokenUpto
-
pendingLimit
private int pendingLimit
-
pendingUpto
private int pendingUpto
-
offset
private int offset
-
sepUpto
private int sepUpto
-
buffer
private final char[] buffer
-
bufferLimit
private int bufferLimit
-
bufferNextRead
private int bufferNextRead
-
-
Constructor Detail
-
SimplePatternSplitTokenizer
public SimplePatternSplitTokenizer(java.lang.String regexp)
SeeRegExp
for the accepted syntax.
-
SimplePatternSplitTokenizer
public SimplePatternSplitTokenizer(Automaton dfa)
Runs a pre-built automaton.
-
SimplePatternSplitTokenizer
public SimplePatternSplitTokenizer(AttributeFactory factory, java.lang.String regexp, int determinizeWorkLimit)
SeeRegExp
for the accepted syntax.
-
SimplePatternSplitTokenizer
public SimplePatternSplitTokenizer(AttributeFactory factory, Automaton dfa)
Runs a pre-built automaton.
-
-
Method Detail
-
fillToken
private void fillToken(int offsetStart)
-
incrementToken
public boolean incrementToken() throws java.io.IOException
Description copied from class:TokenStream
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriateAttributeImpl
s 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)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
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()
.- Specified by:
incrementToken
in classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
java.io.IOException
-
end
public void end() throws java.io.IOException
Description copied from class:TokenStream
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
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.
Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.
If you override this method, always call
super.end()
.- Overrides:
end
in classTokenStream
- Throws:
java.io.IOException
- If an I/O error occurs
-
reset
public void reset() throws java.io.IOException
Description copied from class:TokenStream
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.
If you override this method, always call
super.reset()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on further usage).
-
pushBack
private void pushBack(int count)
Pushes back the lastcount
characters in current token's buffer.
-
appendToToken
private void appendToToken(char ch)
-
nextCodeUnit
private int nextCodeUnit() throws java.io.IOException
- Throws:
java.io.IOException
-
nextCodePoint
private int nextCodePoint() throws java.io.IOException
- Throws:
java.io.IOException
-
-