java.lang.Object | |
↳ | org.apache.lucene.analysis.Analyzer |
Known Direct Subclasses |
An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text.
Typical implementations first build a Tokenizer, which breaks the stream of characters from the Reader into raw Tokens. One or more TokenFilters may then be applied to the output of the Tokenizer.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
overridesTokenStreamMethod | This field is deprecated. No replacement. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Frees persistent resources used by this Analyzer
| |||||||||||
Just like
getPositionIncrementGap(String) , except for
Token offsets instead. | |||||||||||
Invoked before indexing a Fieldable instance if
terms have already been added to that field.
| |||||||||||
Creates a TokenStream that is allowed to be re-used
from the previous time that the same thread called
this method.
| |||||||||||
Creates a TokenStream which tokenizes all the text in the provided
Reader.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Used by Analyzers that implement reusableTokenStream
to retrieve previously saved TokenStreams for re-use
by the same thread.
| |||||||||||
This method is deprecated.
This is only present to preserve
back-compat of classes that subclass a core analyzer
and override tokenStream but not reusableTokenStream
| |||||||||||
Used by Analyzers that implement reusableTokenStream
to save a TokenStream for later re-use by the same
thread.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
|
This field is deprecated.
No replacement.
Frees persistent resources used by this Analyzer
Just like getPositionIncrementGap(String)
, except for
Token offsets instead. By default this returns 1 for
tokenized fields and, as if the fields were joined
with an extra space character, and 0 for un-tokenized
fields. This method is only called if the field
produced at least one token for indexing.
field | the field just indexed |
---|
tokenStream(String, Reader)
Invoked before indexing a Fieldable instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between Fieldable instances using the same field name. The default value position increment gap is 0. With a 0 position increment gap and the typical default token position increment of 1, all terms in a field, including across Fieldable instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across Fieldable instance boundaries.
fieldName | Fieldable name being indexed. |
---|
tokenStream(String, Reader)
Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one TokenStream at the same time from this analyzer should use this method for better performance.
IOException |
---|
Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility.
Used by Analyzers that implement reusableTokenStream to retrieve previously saved TokenStreams for re-use by the same thread.
This method is deprecated.
This is only present to preserve
back-compat of classes that subclass a core analyzer
and override tokenStream but not reusableTokenStream
Used by Analyzers that implement reusableTokenStream to save a TokenStream for later re-use by the same thread.