Package com.atlassian.confluence.plugins.index.api

Class AnalyzerDescriptor

java.lang.Object

com.atlassian.confluence.plugins.index.api.AnalyzerDescriptor

All Implemented Interfaces:

AnalyzerDescriptorProvider, MappingAnalyzerDescriptor

public class AnalyzerDescriptor
extends Object
implements MappingAnalyzerDescriptor

An AnalyzerDescriptor is a combination of a TokenizerDescriptor and some (possibly no) CharFilterDescriptors and TokenFilterDescriptors that collectively describe how to analyse text into tokens.

The analysis chain can be visualised as: Text -> CharFilterDescriptor -> TokenizerDescriptor -> TokenFilterDescriptor -> Tokens

For example: "the quick fox jumped over the lazy dog" ->

CharFilterDescriptor replacing x with a ->

"The quick foa jumped over the lazy dog" ->

WhitespaceTokenizerDescriptor ->

{"The" "quick" "foa" "jumped" "over" "the" "lazy" "dog"} ->

LowerCaseTokenFilter ->

{"the" "quick" "foa" "jumped" "over" "the" "lazy" "dog"} ->

Since:

7.17

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyzerDescriptor.Builder

Method Summary

Modifier and Type	Method	Description
static AnalyzerDescriptor.Builder	builder(TokenizerDescriptor tokenizer)
boolean	equals(Object o)
Collection<CharFilterDescriptor>	getCharFilters()
Collection<TokenFilterDescriptor>	getTokenFilters()
TokenizerDescriptor	getTokenizer()
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.plugins.index.api.MappingAnalyzerDescriptor

getAnalyzer

Method Detail

getCharFilters

public Collection<CharFilterDescriptor> getCharFilters()

getTokenizer

public TokenizerDescriptor getTokenizer()

getTokenFilters

public Collection<TokenFilterDescriptor> getTokenFilters()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static AnalyzerDescriptor.Builder builder(TokenizerDescriptor tokenizer)