public final class StandardTokenizer extends Tokenizer
As of Lucene version 3.1, this class implements the Word Break rules from the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29.
Many applications have specific tokenizer needs. If this tokenizer does not suit your application, please consider copying this source code directory to your project and maintaining your own grammar-based tokenizer.
You must specify the required Version
compatibility when creating StandardTokenizer:
ClassicTokenizer
for backwards compatibility.
AttributeSource.AttributeFactory, AttributeSource.State
Modifier and Type | Field and Description |
---|---|
static int |
ACRONYM
Deprecated.
|
static int |
ACRONYM_DEP
Deprecated.
this solves a bug where HOSTs that end with '.' are identified
as ACRONYMs.
|
static int |
ALPHANUM |
static int |
APOSTROPHE
Deprecated.
|
static int |
CJ
Deprecated.
|
static int |
COMPANY
Deprecated.
|
static int |
EMAIL |
static int |
HANGUL |
static int |
HIRAGANA |
static int |
HOST
Deprecated.
|
static int |
IDEOGRAPHIC |
static int |
KATAKANA |
static int |
NUM |
static int |
SOUTHEAST_ASIAN |
static String[] |
TOKEN_TYPES
String token types that correspond to token type int constants
|
Constructor and Description |
---|
StandardTokenizer(Version matchVersion,
AttributeSource.AttributeFactory factory,
Reader input)
Creates a new StandardTokenizer with a given
AttributeSource.AttributeFactory |
StandardTokenizer(Version matchVersion,
AttributeSource source,
Reader input)
Creates a new StandardTokenizer with a given
AttributeSource . |
StandardTokenizer(Version matchVersion,
Reader input)
Creates a new instance of the
StandardTokenizer . |
Modifier and Type | Method and Description |
---|---|
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() |
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
boolean |
isReplaceInvalidAcronym()
Deprecated.
Remove in 3.X and make true the only valid value
|
void |
reset(Reader reader)
Expert: Reset the tokenizer to a new reader.
|
void |
setMaxTokenLength(int length)
Set the max allowed token length.
|
void |
setReplaceInvalidAcronym(boolean replaceInvalidAcronym)
Deprecated.
Remove in 3.X and make true the only valid value
See https://issues.apache.org/jira/browse/LUCENE-1068
|
close, correctOffset
reset
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
public static final int ALPHANUM
@Deprecated public static final int APOSTROPHE
@Deprecated public static final int ACRONYM
@Deprecated public static final int COMPANY
public static final int EMAIL
@Deprecated public static final int HOST
public static final int NUM
@Deprecated public static final int CJ
@Deprecated public static final int ACRONYM_DEP
public static final int SOUTHEAST_ASIAN
public static final int IDEOGRAPHIC
public static final int HIRAGANA
public static final int KATAKANA
public static final int HANGUL
public static final String[] TOKEN_TYPES
public StandardTokenizer(Version matchVersion, Reader input)
StandardTokenizer
. Attaches
the input
to the newly created JFlex scanner.input
- The input reader
See http://issues.apache.org/jira/browse/LUCENE-1068public StandardTokenizer(Version matchVersion, AttributeSource source, Reader input)
AttributeSource
.public StandardTokenizer(Version matchVersion, AttributeSource.AttributeFactory factory, Reader input)
AttributeSource.AttributeFactory
public void setMaxTokenLength(int length)
public int getMaxTokenLength()
setMaxTokenLength(int)
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
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
@Deprecated public boolean isReplaceInvalidAcronym()
@Deprecated public void setReplaceInvalidAcronym(boolean replaceInvalidAcronym)
replaceInvalidAcronym
- Set to true to replace mischaracterized acronyms as HOST.