|
||||||||||
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.StandardTokenizer
public class StandardTokenizer
A grammar-based tokenizer constructed with JFlex
This should be a good tokenizer for most European-language documents:
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 StandardAnalyzer:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource |
---|
AttributeSource.AttributeFactory, AttributeSource.State |
Field Summary | |
---|---|
static int |
ACRONYM
|
static int |
ACRONYM_DEP
Deprecated. this solves a bug where HOSTs that end with '.' are identified as ACRONYMs. It is deprecated and will be removed in the next release. |
static int |
ALPHANUM
|
static int |
APOSTROPHE
|
static int |
CJ
|
static int |
COMPANY
|
static int |
EMAIL
|
static int |
HOST
|
static int |
NUM
|
static String[] |
TOKEN_TYPES
String token types that correspond to token type int constants |
static String[] |
tokenImage
Deprecated. Please use TOKEN_TYPES instead |
Fields inherited from class org.apache.lucene.analysis.Tokenizer |
---|
input |
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()
|
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 |
Token |
next()
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer. |
Token |
next(Token reusableToken)
Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer. |
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 |
Methods inherited from class org.apache.lucene.analysis.Tokenizer |
---|
close, correctOffset |
Methods inherited from class org.apache.lucene.analysis.TokenStream |
---|
getOnlyUseNewAPI, reset, setOnlyUseNewAPI |
Methods inherited from class org.apache.lucene.util.AttributeSource |
---|
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ALPHANUM
public static final int APOSTROPHE
public static final int ACRONYM
public static final int COMPANY
public static final int EMAIL
public static final int HOST
public static final int NUM
public static final int CJ
public static final int ACRONYM_DEP
public static final String[] TOKEN_TYPES
public static final String[] tokenImage
TOKEN_TYPES
insteadConstructor Detail |
---|
public StandardTokenizer(Reader input)
StandardTokenizer(Version,
Reader)
instead
StandardTokenizer
. Attaches the
input
to a newly created JFlex scanner.
public StandardTokenizer(Reader input, boolean replaceInvalidAcronym)
StandardTokenizer(Version, Reader)
instead
StandardTokenizer
. Attaches
the input
to the newly created JFlex scanner.
input
- The input readerreplaceInvalidAcronym
- Set to true to replace mischaracterized acronyms with HOST.
See http://issues.apache.org/jira/browse/LUCENE-1068public 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(AttributeSource source, Reader input, boolean replaceInvalidAcronym)
StandardTokenizer(Version, AttributeSource, Reader)
instead
AttributeSource
.
public StandardTokenizer(Version matchVersion, AttributeSource source, Reader input)
AttributeSource
.
public StandardTokenizer(AttributeSource.AttributeFactory factory, Reader input, boolean replaceInvalidAcronym)
StandardTokenizer(Version, org.apache.lucene.util.AttributeSource.AttributeFactory, Reader)
instead
AttributeSource.AttributeFactory
public StandardTokenizer(Version matchVersion, AttributeSource.AttributeFactory factory, Reader input)
AttributeSource.AttributeFactory
Method Detail |
---|
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)
or downcasts,
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
Note that this method will be defined abstract in Lucene 3.0.
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 final Token next(Token reusableToken) throws IOException
TokenStream
This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):
Token
before calling this method again.Token.clear()
before setting the fields in
it and returning itToken
after it
has been returned: the caller may arbitrarily change it. If the producer
needs to hold onto the Token
for subsequent calls, it must clone()
it before storing it. Note that a TokenFilter
is considered a
consumer.
next
in class TokenStream
reusableToken
- a Token
that may or may not be used to return;
this parameter should never be null (the callee is not required to
check for null before using it, but it is a good idea to assert that
it is not null.)
Token
in the stream or null if end-of-stream was hit
IOException
public final Token next() throws IOException
TokenStream
Token
in the stream, or null at EOS.
next
in class TokenStream
IOException
public void reset(Reader reader) throws IOException
Tokenizer
reset
in class Tokenizer
IOException
public boolean isReplaceInvalidAcronym()
public void setReplaceInvalidAcronym(boolean replaceInvalidAcronym)
replaceInvalidAcronym
- Set to true to replace mischaracterized acronyms as HOST.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |