Package org.elasticsearch.index.analysis

Class CustomAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.elasticsearch.index.analysis.CustomAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable, AnalyzerComponentsProvider

public final class CustomAnalyzer
extends Analyzer
implements AnalyzerComponentsProvider

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
CustomAnalyzer(TokenizerFactory tokenizerFactory, CharFilterFactory[] charFilters, TokenFilterFactory[] tokenFilters)
CustomAnalyzer(TokenizerFactory tokenizerFactory, CharFilterFactory[] charFilters, TokenFilterFactory[] tokenFilters, int positionIncrementGap, int offsetGap)

Method Summary

Modifier and Type	Method	Description
CharFilterFactory[]	charFilters()
protected Analyzer.TokenStreamComponents	createComponents(String fieldName)	Creates a new Analyzer.TokenStreamComponents instance for this analyzer.
AnalysisMode	getAnalysisMode()
AnalyzerComponents	getComponents()
int	getOffsetGap(String field)	Just like Analyzer.getPositionIncrementGap(java.lang.String), except for Token offsets instead.
int	getPositionIncrementGap(String fieldName)	Invoked before indexing a IndexableField instance if terms have already been added to that field.
protected Reader	initReader(String fieldName, Reader reader)	Override this if you want to add a CharFilter chain.
protected Reader	initReaderForNormalization(String fieldName, Reader reader)	Wrap the given Reader with CharFilters that make sense for normalization.
protected TokenStream	normalize(String fieldName, TokenStream in)	Wrap the given TokenStream in order to apply normalization filters.
TokenFilterFactory[]	tokenFilters()
TokenizerFactory	tokenizerFactory()

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

attributeFactory, close, getReuseStrategy, getVersion, normalize, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomAnalyzer

public CustomAnalyzer(TokenizerFactory tokenizerFactory,
                      CharFilterFactory[] charFilters,
                      TokenFilterFactory[] tokenFilters)

CustomAnalyzer

public CustomAnalyzer(TokenizerFactory tokenizerFactory,
                      CharFilterFactory[] charFilters,
                      TokenFilterFactory[] tokenFilters,
                      int positionIncrementGap,
                      int offsetGap)

Method Detail

tokenizerFactory

public TokenizerFactory tokenizerFactory()

tokenFilters

public TokenFilterFactory[] tokenFilters()

charFilters

public CharFilterFactory[] charFilters()

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 Analyzer

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.

getOffsetGap

public int getOffsetGap(String field)

Description copied from class: Analyzer

Just like Analyzer.getPositionIncrementGap(java.lang.String), except for Token offsets instead. By default this returns 1. This method is only called if the field produced at least one token for indexing.

Overrides:

getOffsetGap in class Analyzer

Parameters:

field - the field just indexed

Returns:

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

getAnalysisMode

public AnalysisMode getAnalysisMode()

getComponents

public AnalyzerComponents getComponents()

Specified by:

getComponents in interface AnalyzerComponentsProvider

createComponents

protected Analyzer.TokenStreamComponents createComponents(String fieldName)

Description copied from class: Analyzer

Creates a new Analyzer.TokenStreamComponents instance for this analyzer.

Specified by:

createComponents in class Analyzer

Parameters:

fieldName - the name of the fields content passed to the Analyzer.TokenStreamComponents sink as a reader

Returns:

the Analyzer.TokenStreamComponents for this analyzer.

initReader

protected Reader initReader(String fieldName,
                            Reader reader)

Description copied from class: Analyzer

Override this if you want to add a CharFilter chain.

The default implementation returns reader unchanged.

Overrides:

initReader in class Analyzer

Parameters:

fieldName - IndexableField name being indexed

reader - original Reader

Returns:

reader, optionally decorated with CharFilter(s)

initReaderForNormalization

protected Reader initReaderForNormalization(String fieldName,
                                            Reader reader)

Description copied from class: Analyzer

Wrap the given Reader with CharFilters that make sense for normalization. This is typically a subset of the CharFilters that are applied in Analyzer.initReader(String, Reader). This is used by Analyzer.normalize(String, String).

Overrides:

initReaderForNormalization in class Analyzer

normalize

protected TokenStream normalize(String fieldName,
                                TokenStream in)

Description copied from class: Analyzer

Wrap the given TokenStream in order to apply normalization filters. The default implementation returns the TokenStream as-is. This is used by Analyzer.normalize(String, String).

Overrides:

normalize in class Analyzer