org.elasticsearch.index.analysis

Class Analysis

java.lang.Object

org.elasticsearch.index.analysis.Analysis

public class Analysis
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableMap<String,Set<?>>	namedStopWords

Constructor Summary

Constructors

Constructor and Description
Analysis()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	generatesCharacterTokenStream(org.apache.lucene.analysis.Analyzer analyzer, String fieldName) Check whether TokenStreams generated with analyzer provide with character terms.
static Reader	getReaderFromFile(Environment env, Settings settings, String settingPrefix)
static List<String>	getWordList(Environment env, Settings settings, String settingPrefix) Fetches a list of words from the specified settings file.
static org.apache.lucene.analysis.util.CharArraySet	getWordSet(Environment env, Settings settings, String settingsPrefix)
static boolean	isCharacterTokenStream(org.apache.lucene.analysis.TokenStream tokenStream) Check whether the provided token stream is able to provide character terms.
static boolean	isNoStopwords(Settings settings)
static List<String>	loadWordList(Reader reader, String comment)
static org.apache.lucene.util.Version	parseAnalysisVersion(Settings indexSettings, Settings settings, ESLogger logger)
static org.apache.lucene.analysis.util.CharArraySet	parseArticles(Environment env, Settings settings)
static org.apache.lucene.analysis.util.CharArraySet	parseCommonWords(Environment env, Settings settings, org.apache.lucene.analysis.util.CharArraySet defaultCommonWords, boolean ignoreCase)
static org.apache.lucene.analysis.util.CharArraySet	parseStemExclusion(Settings settings, org.apache.lucene.analysis.util.CharArraySet defaultStemExclusion)
static org.apache.lucene.analysis.util.CharArraySet	parseStopWords(Environment env, Settings settings, org.apache.lucene.analysis.util.CharArraySet defaultStopWords)
static org.apache.lucene.analysis.util.CharArraySet	parseStopWords(Environment env, Settings settings, org.apache.lucene.analysis.util.CharArraySet defaultStopWords, boolean ignoreCase)
static org.apache.lucene.analysis.util.CharArraySet	parseWords(Environment env, Settings settings, String name, org.apache.lucene.analysis.util.CharArraySet defaultWords, Map<String,Set<?>> namedWords, boolean ignoreCase)

Methods inherited from class java.lang.Object

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

Field Detail

namedStopWords

public static final com.google.common.collect.ImmutableMap<String,Set<?>> namedStopWords

Constructor Detail

Analysis

public Analysis()

Method Detail

parseAnalysisVersion

public static org.apache.lucene.util.Version parseAnalysisVersion(Settings indexSettings,
                                                  Settings settings,
                                                  ESLogger logger)

isNoStopwords

public static boolean isNoStopwords(Settings settings)

parseStemExclusion

public static org.apache.lucene.analysis.util.CharArraySet parseStemExclusion(Settings settings,
                                                              org.apache.lucene.analysis.util.CharArraySet defaultStemExclusion)

parseWords

public static org.apache.lucene.analysis.util.CharArraySet parseWords(Environment env,
                                                      Settings settings,
                                                      String name,
                                                      org.apache.lucene.analysis.util.CharArraySet defaultWords,
                                                      Map<String,Set<?>> namedWords,
                                                      boolean ignoreCase)

parseCommonWords

public static org.apache.lucene.analysis.util.CharArraySet parseCommonWords(Environment env,
                                                            Settings settings,
                                                            org.apache.lucene.analysis.util.CharArraySet defaultCommonWords,
                                                            boolean ignoreCase)

parseArticles

public static org.apache.lucene.analysis.util.CharArraySet parseArticles(Environment env,
                                                         Settings settings)

parseStopWords

public static org.apache.lucene.analysis.util.CharArraySet parseStopWords(Environment env,
                                                          Settings settings,
                                                          org.apache.lucene.analysis.util.CharArraySet defaultStopWords)

parseStopWords

public static org.apache.lucene.analysis.util.CharArraySet parseStopWords(Environment env,
                                                          Settings settings,
                                                          org.apache.lucene.analysis.util.CharArraySet defaultStopWords,
                                                          boolean ignoreCase)

getWordSet

public static org.apache.lucene.analysis.util.CharArraySet getWordSet(Environment env,
                                                      Settings settings,
                                                      String settingsPrefix)

getWordList

public static List<String> getWordList(Environment env,
                       Settings settings,
                       String settingPrefix)

Fetches a list of words from the specified settings file. The list should either be available at the key specified by settingsPrefix or in a file specified by settingsPrefix + _path.

Throws:

IllegalArgumentException - If the word list cannot be found at either key.

loadWordList

public static List<String> loadWordList(Reader reader,
                        String comment)
                                 throws IOException

Throws:

IOException

getReaderFromFile

public static Reader getReaderFromFile(Environment env,
                       Settings settings,
                       String settingPrefix)

Returns:

null If no settings set for "settingsPrefix" then return null.

Throws:

IllegalArgumentException - If the Reader can not be instantiated.

isCharacterTokenStream

public static boolean isCharacterTokenStream(org.apache.lucene.analysis.TokenStream tokenStream)

Check whether the provided token stream is able to provide character terms.

Although most analyzers generate character terms (CharTermAttribute), some token only contain binary terms (BinaryTermAttribute, CharTermAttribute being a special type of BinaryTermAttribute), such as NumericTokenStream and unsuitable for highlighting and more-like-this queries which expect character terms.

generatesCharacterTokenStream

public static boolean generatesCharacterTokenStream(org.apache.lucene.analysis.Analyzer analyzer,
                                    String fieldName)
                                             throws IOException

Check whether TokenStreams generated with analyzer provide with character terms.

Throws:

IOException

See Also:

isCharacterTokenStream(TokenStream)