Class UAX29URLEmailTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.Tokenizer
-
- org.apache.lucene.analysis.email.UAX29URLEmailTokenizer
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public final class UAX29URLEmailTokenizer extends Tokenizer
This class implements Word Break rules from the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29 URLs and email addresses are also tokenized according to the relevant RFCs.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALPHANUM
Alpha/numeric token typestatic int
EMAIL
Email token typestatic int
EMOJI
Emoji token type.static int
HANGUL
Hangul token typestatic int
HIRAGANA
Hiragana token typestatic int
IDEOGRAPHIC
Ideographic token typestatic int
KATAKANA
Katakana token typestatic int
MAX_TOKEN_LENGTH_LIMIT
Absolute maximum sized tokenprivate int
maxTokenLength
static int
NUM
Numeric token typeprivate OffsetAttribute
offsetAtt
private PositionIncrementAttribute
posIncrAtt
private UAX29URLEmailTokenizerImpl
scanner
A private instance of the JFlex-constructed scannerprivate int
skippedPositions
static int
SOUTHEAST_ASIAN
Southeast Asian token typeprivate CharTermAttribute
termAtt
static java.lang.String[]
TOKEN_TYPES
String token types that correspond to token type int constantsprivate TypeAttribute
typeAtt
static int
URL
URL token type-
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
-
Constructor Summary
Constructors Constructor Description UAX29URLEmailTokenizer()
Creates a new instance of the UAX29URLEmailTokenizer.UAX29URLEmailTokenizer(AttributeFactory factory)
Creates a new UAX29URLEmailTokenizer with a givenAttributeFactory
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Releases resources associated with this stream.void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).int
getMaxTokenLength()
private UAX29URLEmailTokenizerImpl
getScanner()
boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.void
setMaxTokenLength(int length)
Set the max allowed token length.-
Methods inherited from class org.apache.lucene.analysis.Tokenizer
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
-
scanner
private final UAX29URLEmailTokenizerImpl scanner
A private instance of the JFlex-constructed scanner
-
ALPHANUM
public static final int ALPHANUM
Alpha/numeric token type- See Also:
- Constant Field Values
-
NUM
public static final int NUM
Numeric token type- See Also:
- Constant Field Values
-
SOUTHEAST_ASIAN
public static final int SOUTHEAST_ASIAN
Southeast Asian token type- See Also:
- Constant Field Values
-
IDEOGRAPHIC
public static final int IDEOGRAPHIC
Ideographic token type- See Also:
- Constant Field Values
-
HIRAGANA
public static final int HIRAGANA
Hiragana token type- See Also:
- Constant Field Values
-
KATAKANA
public static final int KATAKANA
Katakana token type- See Also:
- Constant Field Values
-
HANGUL
public static final int HANGUL
Hangul token type- See Also:
- Constant Field Values
-
URL
public static final int URL
URL token type- See Also:
- Constant Field Values
-
EMAIL
public static final int EMAIL
Email token type- See Also:
- Constant Field Values
-
EMOJI
public static final int EMOJI
Emoji token type.- See Also:
- Constant Field Values
-
TOKEN_TYPES
public static final java.lang.String[] TOKEN_TYPES
String token types that correspond to token type int constants
-
MAX_TOKEN_LENGTH_LIMIT
public static final int MAX_TOKEN_LENGTH_LIMIT
Absolute maximum sized token- See Also:
- Constant Field Values
-
skippedPositions
private int skippedPositions
-
maxTokenLength
private int maxTokenLength
-
termAtt
private final CharTermAttribute termAtt
-
offsetAtt
private final OffsetAttribute offsetAtt
-
posIncrAtt
private final PositionIncrementAttribute posIncrAtt
-
typeAtt
private final TypeAttribute typeAtt
-
-
Constructor Detail
-
UAX29URLEmailTokenizer
public UAX29URLEmailTokenizer()
Creates a new instance of the UAX29URLEmailTokenizer. Attaches theinput
to the newly created JFlex scanner.
-
UAX29URLEmailTokenizer
public UAX29URLEmailTokenizer(AttributeFactory factory)
Creates a new UAX29URLEmailTokenizer with a givenAttributeFactory
-
-
Method Detail
-
setMaxTokenLength
public void setMaxTokenLength(int length)
Set the max allowed token length. Tokens larger than this will be chopped up at this token length and emitted as multiple tokens. If you need to skip such large tokens, you could increase this max length, and then useLengthFilter
to remove long tokens. The default isUAX29URLEmailAnalyzer.DEFAULT_MAX_TOKEN_LENGTH
.- Throws:
java.lang.IllegalArgumentException
- if the given length is outside of the range [1, 1048576].
-
getMaxTokenLength
public int getMaxTokenLength()
- See Also:
setMaxTokenLength(int)
-
getScanner
private UAX29URLEmailTokenizerImpl getScanner()
-
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
-
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
-
close
public void close() throws java.io.IOException
Description copied from class:Tokenizer
Releases resources associated with this stream.If you override this method, always call
super.close()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on reuse).NOTE: The default implementation closes the input Reader, so be sure to call
super.close()
when overriding this method.
-
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).
-
-