Uses of Class
org.apache.lucene.analysis.Token

Packages that use Token

org.apache.lucene.analysis	API and code to convert text into indexable/searchable tokens.
org.apache.lucene.analysis.compound	A filter that decomposes compound words you find in many Germanic languages into the word parts.
org.apache.lucene.analysis.fr	Analyzer for French.
org.apache.lucene.analysis.miscellaneous	Miscellaneous TokenStreams
org.apache.lucene.analysis.ngram	Character n-gram tokenizers and filters.
org.apache.lucene.analysis.payloads	Provides various convenience classes for creating payloads on Tokens.
org.apache.lucene.analysis.position	Filter for assigning position increments.
org.apache.lucene.analysis.shingle	Word n-gram filters
org.apache.lucene.analysis.sinks	Implementations of the SinkTokenizer that might be useful.
org.apache.lucene.analysis.snowball	TokenFilter and Analyzer implementations that use Snowball stemmers.
org.apache.lucene.analysis.standard	A fast grammar-based tokenizer constructed with JFlex.
org.apache.lucene.analysis.th	Analyzer for Thai.
org.apache.lucene.search.highlight	The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.
org.apache.lucene.wikipedia.analysis	Tokenizer that is aware of Wikipedia syntax.

Uses of Token in org.apache.lucene.analysis

Methods in org.apache.lucene.analysis that return Token

Token	Token.clone(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset) Makes a clone, but replaces the term buffer & start/end offset in the process.
Token	KeywordTokenizer.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	ISOLatin1AccentFilter.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	CharTokenizer.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	CachingTokenFilter.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	TokenStream.next() Deprecated. The returned Token is a "full private copy" (not re-used across calls to TokenStream.next()) but will be slower than calling TokenStream.next(Token) or using the new TokenStream.incrementToken() method with the new AttributeSource API.
Token	TeeTokenFilter.next(Token reusableToken) Deprecated.
Token	SinkTokenizer.next(Token reusableToken) Deprecated. Returns the next token out of the list of cached tokens
Token	KeywordTokenizer.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.
Token	ISOLatin1AccentFilter.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.
Token	CharTokenizer.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.
Token	CachingTokenFilter.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.
Token	TokenStream.next(Token reusableToken) Deprecated. The new TokenStream.incrementToken() and AttributeSource APIs should be used instead.
Token	Token.reinit(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset) Shorthand for calling clear(), setTermBuffer(char[], int, int), setStartOffset(int), setEndOffset(int) setType(java.lang.String) on Token.DEFAULT_TYPE
Token	Token.reinit(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset, String newType) Shorthand for calling clear(), setTermBuffer(char[], int, int), setStartOffset(int), setEndOffset(int), setType(java.lang.String)
Token	Token.reinit(String newTerm, int newStartOffset, int newEndOffset) Shorthand for calling clear(), setTermBuffer(String), setStartOffset(int), setEndOffset(int) setType(java.lang.String) on Token.DEFAULT_TYPE
Token	Token.reinit(String newTerm, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset) Shorthand for calling clear(), setTermBuffer(String, int, int), setStartOffset(int), setEndOffset(int) setType(java.lang.String) on Token.DEFAULT_TYPE
Token	Token.reinit(String newTerm, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset, String newType) Shorthand for calling clear(), setTermBuffer(String, int, int), setStartOffset(int), setEndOffset(int) setType(java.lang.String)
Token	Token.reinit(String newTerm, int newStartOffset, int newEndOffset, String newType) Shorthand for calling clear(), setTermBuffer(String), setStartOffset(int), setEndOffset(int) setType(java.lang.String)

Methods in org.apache.lucene.analysis with parameters of type Token

void	SinkTokenizer.add(Token t) Deprecated. Override this method to cache only certain tokens, or new tokens based on the old tokens.
Token	TeeTokenFilter.next(Token reusableToken) Deprecated.
Token	SinkTokenizer.next(Token reusableToken) Deprecated. Returns the next token out of the list of cached tokens
Token	KeywordTokenizer.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.
Token	ISOLatin1AccentFilter.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.
Token	CharTokenizer.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.
Token	CachingTokenFilter.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.
Token	TokenStream.next(Token reusableToken) Deprecated. The new TokenStream.incrementToken() and AttributeSource APIs should be used instead.
void	Token.reinit(Token prototype) Copy the prototype token's fields into this one.
void	Token.reinit(Token prototype, char[] newTermBuffer, int offset, int length) Copy the prototype token's fields into this one, with a different term.
void	Token.reinit(Token prototype, String newTerm) Copy the prototype token's fields into this one, with a different term.

Uses of Token in org.apache.lucene.analysis.compound

Methods in org.apache.lucene.analysis.compound that return Token

protected Token	CompoundWordTokenFilterBase.createToken(int offset, int length, Token prototype)
Token	CompoundWordTokenFilterBase.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	CompoundWordTokenFilterBase.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.

Methods in org.apache.lucene.analysis.compound with parameters of type Token

protected Token	CompoundWordTokenFilterBase.createToken(int offset, int length, Token prototype)
protected void	CompoundWordTokenFilterBase.decompose(Token token)
protected void	HyphenationCompoundWordTokenFilter.decomposeInternal(Token token)
protected void	DictionaryCompoundWordTokenFilter.decomposeInternal(Token token)
protected abstract void	CompoundWordTokenFilterBase.decomposeInternal(Token token)
Token	CompoundWordTokenFilterBase.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.

Uses of Token in org.apache.lucene.analysis.fr

Methods in org.apache.lucene.analysis.fr that return Token

Token	ElisionFilter.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	ElisionFilter.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.

Methods in org.apache.lucene.analysis.fr with parameters of type Token

Token

ElisionFilter.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.

Uses of Token in org.apache.lucene.analysis.miscellaneous

Methods in org.apache.lucene.analysis.miscellaneous that return Token

Token	SingleTokenTokenStream.getToken()
Token	PrefixAndSuffixAwareTokenFilter.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	EmptyTokenStream.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	PrefixAwareTokenFilter.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	SingleTokenTokenStream.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	PrefixAndSuffixAwareTokenFilter.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.
Token	EmptyTokenStream.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.
Token	PrefixAwareTokenFilter.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.
Token	SingleTokenTokenStream.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.
Token	PrefixAndSuffixAwareTokenFilter.updateInputToken(Token inputToken, Token lastPrefixToken)
Token	PrefixAndSuffixAwareTokenFilter.updateSuffixToken(Token suffixToken, Token lastInputToken)
Token	PrefixAwareTokenFilter.updateSuffixToken(Token suffixToken, Token lastPrefixToken) The default implementation adds last prefix token end offset to the suffix token start and end offsets.

Methods in org.apache.lucene.analysis.miscellaneous with parameters of type Token

Token	PrefixAndSuffixAwareTokenFilter.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.
Token	EmptyTokenStream.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.
Token	PrefixAwareTokenFilter.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.
Token	SingleTokenTokenStream.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	SingleTokenTokenStream.setToken(Token token)
Token	PrefixAndSuffixAwareTokenFilter.updateInputToken(Token inputToken, Token lastPrefixToken)
Token	PrefixAndSuffixAwareTokenFilter.updateSuffixToken(Token suffixToken, Token lastInputToken)
Token	PrefixAwareTokenFilter.updateSuffixToken(Token suffixToken, Token lastPrefixToken) The default implementation adds last prefix token end offset to the suffix token start and end offsets.

Constructors in org.apache.lucene.analysis.miscellaneous with parameters of type Token

SingleTokenTokenStream(Token token)

Uses of Token in org.apache.lucene.analysis.ngram

Methods in org.apache.lucene.analysis.ngram that return Token

Token	NGramTokenFilter.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	EdgeNGramTokenizer.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	EdgeNGramTokenFilter.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	NGramTokenizer.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	NGramTokenFilter.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.
Token	EdgeNGramTokenizer.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.
Token	EdgeNGramTokenFilter.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.
Token	NGramTokenizer.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.

Methods in org.apache.lucene.analysis.ngram with parameters of type Token

Token	NGramTokenFilter.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.
Token	EdgeNGramTokenizer.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.
Token	EdgeNGramTokenFilter.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.
Token	NGramTokenizer.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.

Uses of Token in org.apache.lucene.analysis.payloads

Methods in org.apache.lucene.analysis.payloads that return Token

Token	TokenOffsetPayloadTokenFilter.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	TypeAsPayloadTokenFilter.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	NumericPayloadTokenFilter.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	TokenOffsetPayloadTokenFilter.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.
Token	TypeAsPayloadTokenFilter.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.
Token	NumericPayloadTokenFilter.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.

Methods in org.apache.lucene.analysis.payloads with parameters of type Token

Token	TokenOffsetPayloadTokenFilter.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.
Token	TypeAsPayloadTokenFilter.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.
Token	NumericPayloadTokenFilter.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.

Uses of Token in org.apache.lucene.analysis.position

Methods in org.apache.lucene.analysis.position that return Token

Token	PositionFilter.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	PositionFilter.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.

Methods in org.apache.lucene.analysis.position with parameters of type Token

Token

PositionFilter.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.

Uses of Token in org.apache.lucene.analysis.shingle

Methods in org.apache.lucene.analysis.shingle that return Token

Token	ShingleMatrixFilter.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	ShingleFilter.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	ShingleMatrixFilter.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.
Token	ShingleFilter.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.

Methods in org.apache.lucene.analysis.shingle with parameters of type Token

float	ShingleMatrixFilter.calculateShingleWeight(Token shingleToken, List shingle, int currentPermutationStartOffset, List currentPermutationRows, List currentPermuationTokens) Evaluates the new shingle token weight.
abstract ShingleMatrixFilter.TokenPositioner	ShingleMatrixFilter.TokenSettingsCodec.getTokenPositioner(Token token) Retrieves information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
ShingleMatrixFilter.TokenPositioner	ShingleMatrixFilter.OneDimensionalNonWeightedTokenSettingsCodec.getTokenPositioner(Token token)
ShingleMatrixFilter.TokenPositioner	ShingleMatrixFilter.TwoDimensionalNonWeightedSynonymTokenSettingsCodec.getTokenPositioner(Token token)
ShingleMatrixFilter.TokenPositioner	ShingleMatrixFilter.SimpleThreeDimensionalTokenSettingsCodec.getTokenPositioner(Token token)
abstract float	ShingleMatrixFilter.TokenSettingsCodec.getWeight(Token token) Have this method return 1f in order to 'disable' weights.
float	ShingleMatrixFilter.OneDimensionalNonWeightedTokenSettingsCodec.getWeight(Token token)
float	ShingleMatrixFilter.TwoDimensionalNonWeightedSynonymTokenSettingsCodec.getWeight(Token token)
float	ShingleMatrixFilter.SimpleThreeDimensionalTokenSettingsCodec.getWeight(Token token) Returns a 32 bit float from the payload, or 1f it null.
Token	ShingleMatrixFilter.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.
Token	ShingleFilter.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.
abstract void	ShingleMatrixFilter.TokenSettingsCodec.setTokenPositioner(Token token, ShingleMatrixFilter.TokenPositioner tokenPositioner) Sets information on how a Token is to be inserted to a ShingleMatrixFilter.Matrix.
void	ShingleMatrixFilter.OneDimensionalNonWeightedTokenSettingsCodec.setTokenPositioner(Token token, ShingleMatrixFilter.TokenPositioner tokenPositioner)
void	ShingleMatrixFilter.TwoDimensionalNonWeightedSynonymTokenSettingsCodec.setTokenPositioner(Token token, ShingleMatrixFilter.TokenPositioner tokenPositioner)
void	ShingleMatrixFilter.SimpleThreeDimensionalTokenSettingsCodec.setTokenPositioner(Token token, ShingleMatrixFilter.TokenPositioner tokenPositioner) Sets the TokenPositioner as token flags int value.
abstract void	ShingleMatrixFilter.TokenSettingsCodec.setWeight(Token token, float weight) Have this method do nothing in order to 'disable' weights.
void	ShingleMatrixFilter.OneDimensionalNonWeightedTokenSettingsCodec.setWeight(Token token, float weight)
void	ShingleMatrixFilter.TwoDimensionalNonWeightedSynonymTokenSettingsCodec.setWeight(Token token, float weight)
void	ShingleMatrixFilter.SimpleThreeDimensionalTokenSettingsCodec.setWeight(Token token, float weight) Stores a 32 bit float in the payload, or set it to null if 1f;
void	ShingleMatrixFilter.updateToken(Token token, List shingle, int currentPermutationStartOffset, List currentPermutationRows, List currentPermuationTokens) Final touch of a shingle token before it is passed on to the consumer from method ShingleMatrixFilter.next(org.apache.lucene.analysis.Token).

Constructors in org.apache.lucene.analysis.shingle with parameters of type Token

ShingleMatrixFilter.Matrix.Column(Token token)

Uses of Token in org.apache.lucene.analysis.sinks

Methods in org.apache.lucene.analysis.sinks with parameters of type Token

void	TokenRangeSinkTokenizer.add(Token t) Deprecated.
void	DateRecognizerSinkTokenizer.add(Token t) Deprecated.
void	TokenTypeSinkTokenizer.add(Token t) Deprecated.

Uses of Token in org.apache.lucene.analysis.snowball

Methods in org.apache.lucene.analysis.snowball that return Token

Token	SnowballFilter.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	SnowballFilter.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.

Methods in org.apache.lucene.analysis.snowball with parameters of type Token

Token

SnowballFilter.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.

Uses of Token in org.apache.lucene.analysis.standard

Methods in org.apache.lucene.analysis.standard that return Token

Token	StandardTokenizer.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	StandardTokenizer.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.

Methods in org.apache.lucene.analysis.standard with parameters of type Token

Token

StandardTokenizer.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.

Uses of Token in org.apache.lucene.analysis.th

Methods in org.apache.lucene.analysis.th that return Token

Token	ThaiWordFilter.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	ThaiWordFilter.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.

Methods in org.apache.lucene.analysis.th with parameters of type Token

Token

ThaiWordFilter.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.

Uses of Token in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight that return Token

Token

TokenGroup.getToken(int index)

Uses of Token in org.apache.lucene.wikipedia.analysis

Methods in org.apache.lucene.wikipedia.analysis that return Token

Token	WikipediaTokenizer.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	WikipediaTokenizer.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.

Methods in org.apache.lucene.wikipedia.analysis with parameters of type Token

Token

WikipediaTokenizer.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.