Class NGramTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.Tokenizer
-
- org.apache.lucene.analysis.ngram.NGramTokenizer
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
EdgeNGramTokenizer
public class NGramTokenizer extends Tokenizer
Tokenizes the input into n-grams of the given size(s).On the contrary to
NGramTokenFilter
, this class sets offsets so that characters between startOffset and endOffset in the original stream are the same as the term chars.For example, "abcde" would be tokenized as (minGram=2, maxGram=3):
Term ab abc bc bcd cd cde de Position increment 1 1 1 1 1 1 1 Position length 1 1 1 1 1 1 1 Offsets [0,2[ [0,3[ [1,3[ [1,4[ [2,4[ [2,5[ [3,5[ This tokenizer changed a lot in Lucene 4.4 in order to:
- tokenize in a streaming fashion to support streams which are larger than 1024 chars (limit of the previous version),
- count grams based on unicode code points instead of java chars (and never split in the middle of surrogate pairs),
- give the ability to
pre-tokenize
the stream before computing n-grams.
Additionally, this class doesn't trim trailing whitespaces and emits tokens in a different order, tokens are now emitted by increasing start offsets while they used to be emitted by increasing lengths (which prevented from supporting large input streams).
-
-
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 int[]
buffer
private int
bufferEnd
private int
bufferStart
private CharacterUtils.CharacterBuffer
charBuffer
static int
DEFAULT_MAX_NGRAM_SIZE
static int
DEFAULT_MIN_NGRAM_SIZE
private boolean
edgesOnly
private boolean
exhausted
private int
gramSize
private int
lastCheckedChar
private int
lastNonTokenChar
private int
maxGram
private int
minGram
private int
offset
private OffsetAttribute
offsetAtt
private PositionIncrementAttribute
posIncAtt
private PositionLengthAttribute
posLenAtt
private CharTermAttribute
termAtt
-
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
-
Constructor Summary
Constructors Constructor Description NGramTokenizer()
Creates NGramTokenizer with default min and max n-grams.NGramTokenizer(int minGram, int maxGram)
Creates NGramTokenizer with given min and max n-grams.NGramTokenizer(int minGram, int maxGram, boolean edgesOnly)
NGramTokenizer(AttributeFactory factory, int minGram, int maxGram)
Creates NGramTokenizer with given min and max n-grams.NGramTokenizer(AttributeFactory factory, int minGram, int maxGram, boolean edgesOnly)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
consume()
Consume one code point.void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.private void
init(int minGram, int maxGram, boolean edgesOnly)
protected boolean
isTokenChar(int chr)
Only collect characters which satisfy this condition.void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.private void
updateLastNonTokenChar()
-
Methods inherited from class org.apache.lucene.analysis.Tokenizer
close, correctOffset, setReader
-
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
-
DEFAULT_MIN_NGRAM_SIZE
public static final int DEFAULT_MIN_NGRAM_SIZE
- See Also:
- Constant Field Values
-
DEFAULT_MAX_NGRAM_SIZE
public static final int DEFAULT_MAX_NGRAM_SIZE
- See Also:
- Constant Field Values
-
charBuffer
private CharacterUtils.CharacterBuffer charBuffer
-
buffer
private int[] buffer
-
bufferStart
private int bufferStart
-
bufferEnd
private int bufferEnd
-
offset
private int offset
-
gramSize
private int gramSize
-
minGram
private int minGram
-
maxGram
private int maxGram
-
exhausted
private boolean exhausted
-
lastCheckedChar
private int lastCheckedChar
-
lastNonTokenChar
private int lastNonTokenChar
-
edgesOnly
private boolean edgesOnly
-
termAtt
private final CharTermAttribute termAtt
-
posIncAtt
private final PositionIncrementAttribute posIncAtt
-
posLenAtt
private final PositionLengthAttribute posLenAtt
-
offsetAtt
private final OffsetAttribute offsetAtt
-
-
Constructor Detail
-
NGramTokenizer
NGramTokenizer(int minGram, int maxGram, boolean edgesOnly)
-
NGramTokenizer
public NGramTokenizer(int minGram, int maxGram)
Creates NGramTokenizer with given min and max n-grams.- Parameters:
minGram
- the smallest n-gram to generatemaxGram
- the largest n-gram to generate
-
NGramTokenizer
NGramTokenizer(AttributeFactory factory, int minGram, int maxGram, boolean edgesOnly)
-
NGramTokenizer
public NGramTokenizer(AttributeFactory factory, int minGram, int maxGram)
Creates NGramTokenizer with given min and max n-grams.- Parameters:
factory
-AttributeFactory
to useminGram
- the smallest n-gram to generatemaxGram
- the largest n-gram to generate
-
NGramTokenizer
public NGramTokenizer()
Creates NGramTokenizer with default min and max n-grams.
-
-
Method Detail
-
init
private void init(int minGram, int maxGram, boolean edgesOnly)
-
incrementToken
public final 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
-
updateLastNonTokenChar
private void updateLastNonTokenChar()
-
consume
private void consume()
Consume one code point.
-
isTokenChar
protected boolean isTokenChar(int chr)
Only collect characters which satisfy this condition.
-
end
public final 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 final 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).
-
-