Package org.elasticsearch.index.analysis

Class NamedAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.AnalyzerWrapper

org.apache.lucene.analysis.DelegatingAnalyzerWrapper

org.elasticsearch.index.analysis.NamedAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class NamedAnalyzer
extends DelegatingAnalyzerWrapper

Named analyzer is an analyzer wrapper around an actual analyzer (analyzer that is associated with a name (name().

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents

Field Summary

Fields inherited from class org.apache.lucene.analysis.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
NamedAnalyzer(String name, AnalyzerScope scope, Analyzer analyzer)
NamedAnalyzer(NamedAnalyzer analyzer, int positionIncrementGap)

Method Summary

Modifier and Type	Method	Description
Analyzer	analyzer()	The actual analyzer.
void	checkAllowedInMode(AnalysisMode mode)	Checks the wrapped analyzer for the provided restricted AnalysisMode and throws an error if the analyzer is not allowed to run in that mode.
void	close()	Frees persistent resources used by this Analyzer
boolean	equals(Object o)
AnalysisMode	getAnalysisMode()	Returns whether this analyzer can be updated
int	getPositionIncrementGap(String fieldName)	Invoked before indexing a IndexableField instance if terms have already been added to that field.
protected Analyzer	getWrappedAnalyzer(String fieldName)	Retrieves the wrapped Analyzer appropriate for analyzing the field with the given name
int	hashCode()
String	name()	The name of the analyzer.
AnalyzerScope	scope()	The scope of the analyzer.
String	toString()

Methods inherited from class org.apache.lucene.analysis.DelegatingAnalyzerWrapper

wrapComponents, wrapReader, wrapReaderForNormalization, wrapTokenStreamForNormalization

Methods inherited from class org.apache.lucene.analysis.AnalyzerWrapper

attributeFactory, createComponents, getOffsetGap, initReader, initReaderForNormalization, normalize

Methods inherited from class org.apache.lucene.analysis.Analyzer

getReuseStrategy, getVersion, normalize, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedAnalyzer

public NamedAnalyzer(NamedAnalyzer analyzer,
                     int positionIncrementGap)

NamedAnalyzer

public NamedAnalyzer(String name,
                     AnalyzerScope scope,
                     Analyzer analyzer)

Method Detail

name

public String name()

The name of the analyzer.

scope

public AnalyzerScope scope()

The scope of the analyzer.

getAnalysisMode

public AnalysisMode getAnalysisMode()

Returns whether this analyzer can be updated

analyzer

public Analyzer analyzer()

The actual analyzer.

getWrappedAnalyzer

protected Analyzer getWrappedAnalyzer(String fieldName)

Description copied from class: AnalyzerWrapper

Retrieves the wrapped Analyzer appropriate for analyzing the field with the given name

Specified by:

getWrappedAnalyzer in class AnalyzerWrapper

Parameters:

fieldName - Name of the field which is to be analyzed

Returns:

Analyzer for the field with the given name. Assumed to be non-null

getPositionIncrementGap

public int getPositionIncrementGap(String fieldName)

Description copied from class: Analyzer

Invoked before indexing a IndexableField instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between IndexbleField 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 IndexableField instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across IndexableField instance boundaries.

Overrides:

getPositionIncrementGap in class AnalyzerWrapper

Parameters:

fieldName - IndexableField name being indexed.

Returns:

position increment gap, added to the next token emitted from Analyzer.tokenStream(String,Reader). This value must be >= 0.

checkAllowedInMode

public void checkAllowedInMode(AnalysisMode mode)

Checks the wrapped analyzer for the provided restricted AnalysisMode and throws an error if the analyzer is not allowed to run in that mode. The error contains more detailed information about the offending filters that caused the analyzer to not be allowed in this mode.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

close

public void close()

Description copied from class: Analyzer

Frees persistent resources used by this Analyzer

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Analyzer