|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.util.AttributeSource org.apache.lucene.analysis.TokenStream org.apache.lucene.analysis.Tokenizer org.apache.lucene.analysis.standard.UAX29URLEmailTokenizer
public final class UAX29URLEmailTokenizer
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.
Tokens produced are of the following types:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource |
---|
AttributeSource.AttributeFactory, AttributeSource.State |
Field Summary | |
---|---|
static String |
EMAIL_TYPE
E-mail addresses |
static String |
HANGUL_TYPE
|
static String |
HIRAGANA_TYPE
|
static String |
IDEOGRAPHIC_TYPE
|
static String |
KATAKANA_TYPE
|
static String |
NUMERIC_TYPE
Numbers |
static String |
SOUTH_EAST_ASIAN_TYPE
Chars in class \p{Line_Break = Complex_Context} are from South East Asian scripts (Thai, Lao, Myanmar, Khmer, etc.). |
static String |
URL_TYPE
URLs with scheme: HTTP(S), FTP, or FILE; no-scheme URLs match HTTP syntax |
static String |
WORD_TYPE
Alphanumeric sequences |
Fields inherited from class org.apache.lucene.analysis.Tokenizer |
---|
input |
Constructor Summary | |
---|---|
UAX29URLEmailTokenizer(AttributeSource.AttributeFactory factory,
Reader input)
|
|
UAX29URLEmailTokenizer(AttributeSource source,
Reader input)
|
|
UAX29URLEmailTokenizer(InputStream in)
Creates a new scanner. |
|
UAX29URLEmailTokenizer(Reader in)
Creates a new scanner There is also a java.io.InputStream version of this constructor. |
Method Summary | |
---|---|
void |
end()
This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false
(using the new TokenStream API). |
int |
getMaxTokenLength()
Returns the max allowed token length. |
boolean |
incrementToken()
Consumers (i.e., IndexWriter ) use this method to advance the stream to
the next token. |
void |
reset(Reader reader)
Expert: Reset the tokenizer to a new reader. |
void |
setMaxTokenLength(int length)
Set the max allowed token length. |
Methods inherited from class org.apache.lucene.analysis.Tokenizer |
---|
close, correctOffset |
Methods inherited from class org.apache.lucene.analysis.TokenStream |
---|
reset |
Methods inherited from class org.apache.lucene.util.AttributeSource |
---|
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String WORD_TYPE
public static final String NUMERIC_TYPE
public static final String URL_TYPE
public static final String EMAIL_TYPE
public static final String SOUTH_EAST_ASIAN_TYPE
See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
public static final String IDEOGRAPHIC_TYPE
public static final String HIRAGANA_TYPE
public static final String KATAKANA_TYPE
public static final String HANGUL_TYPE
Constructor Detail |
---|
public UAX29URLEmailTokenizer(AttributeSource source, Reader input)
source
- The AttributeSource to useinput
- The input readerpublic UAX29URLEmailTokenizer(AttributeSource.AttributeFactory factory, Reader input)
factory
- The AttributeFactory to useinput
- The input readerpublic UAX29URLEmailTokenizer(Reader in)
in
- the java.io.Reader to read input from.public UAX29URLEmailTokenizer(InputStream in)
in
- the java.io.Inputstream to read input from.Method Detail |
---|
public void setMaxTokenLength(int length)
length
- the new max allowed token lengthpublic int getMaxTokenLength()
public final void end()
TokenStream
TokenStream.incrementToken()
returned false
(using the new TokenStream
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.
end
in class TokenStream
public void reset(Reader reader) throws IOException
Tokenizer
reset
in class Tokenizer
IOException
public final boolean incrementToken() throws IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
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)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
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()
.
incrementToken
in class TokenStream
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |