Class Analysis


  • public class Analysis
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Map<java.lang.String,​java.util.Set<?>> NAMED_STOP_WORDS  
    • Constructor Summary

      Constructors 
      Constructor Description
      Analysis()  
    • Method Summary

      Modifier and Type Method Description
      static java.io.Reader getReaderFromFile​(Environment env, Settings settings, java.lang.String settingPrefix)  
      static java.util.List<java.lang.String> getWordList​(Environment env, Settings settings, java.lang.String settingPrefix)
      Fetches a list of words from the specified settings file.
      static java.util.List<java.lang.String> getWordList​(Environment env, Settings settings, java.lang.String settingPath, java.lang.String settingList)
      Fetches a list of words from the specified settings file.
      static org.apache.lucene.analysis.CharArraySet getWordSet​(Environment env, Version indexCreatedVersion, Settings settings, java.lang.String settingsPrefix)  
      static boolean isNoStopwords​(Settings settings)  
      static java.util.List<java.lang.String> loadWordList​(java.io.Reader reader, java.lang.String comment)  
      static org.apache.lucene.util.Version parseAnalysisVersion​(Settings indexSettings, Settings settings, org.apache.logging.log4j.Logger logger)  
      static org.apache.lucene.analysis.CharArraySet parseArticles​(Environment env, Version indexCreatedVersion, Settings settings)  
      static org.apache.lucene.analysis.CharArraySet parseCommonWords​(Environment env, Settings settings, org.apache.lucene.analysis.CharArraySet defaultCommonWords, boolean ignoreCase)  
      static org.apache.lucene.analysis.CharArraySet parseStemExclusion​(Settings settings, org.apache.lucene.analysis.CharArraySet defaultStemExclusion)  
      static org.apache.lucene.analysis.CharArraySet parseStopWords​(Environment env, Settings settings, org.apache.lucene.analysis.CharArraySet defaultStopWords, boolean ignoreCase)  
      static org.apache.lucene.analysis.CharArraySet parseStopWords​(Environment env, Version indexCreatedVersion, Settings settings, org.apache.lucene.analysis.CharArraySet defaultStopWords)  
      static org.apache.lucene.analysis.CharArraySet parseWords​(Environment env, Settings settings, java.lang.String name, org.apache.lucene.analysis.CharArraySet defaultWords, java.util.Map<java.lang.String,​java.util.Set<?>> namedWords, boolean ignoreCase)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NAMED_STOP_WORDS

        public static final java.util.Map<java.lang.String,​java.util.Set<?>> NAMED_STOP_WORDS
    • Constructor Detail

      • Analysis

        public Analysis()
    • Method Detail

      • parseAnalysisVersion

        public static org.apache.lucene.util.Version parseAnalysisVersion​(Settings indexSettings,
                                                                          Settings settings,
                                                                          org.apache.logging.log4j.Logger logger)
      • isNoStopwords

        public static boolean isNoStopwords​(Settings settings)
      • parseStemExclusion

        public static org.apache.lucene.analysis.CharArraySet parseStemExclusion​(Settings settings,
                                                                                 org.apache.lucene.analysis.CharArraySet defaultStemExclusion)
      • parseWords

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

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

        public static org.apache.lucene.analysis.CharArraySet parseArticles​(Environment env,
                                                                            Version indexCreatedVersion,
                                                                            Settings settings)
      • parseStopWords

        public static org.apache.lucene.analysis.CharArraySet parseStopWords​(Environment env,
                                                                             Version indexCreatedVersion,
                                                                             Settings settings,
                                                                             org.apache.lucene.analysis.CharArraySet defaultStopWords)
      • parseStopWords

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

        public static org.apache.lucene.analysis.CharArraySet getWordSet​(Environment env,
                                                                         Version indexCreatedVersion,
                                                                         Settings settings,
                                                                         java.lang.String settingsPrefix)
      • getWordList

        public static java.util.List<java.lang.String> getWordList​(Environment env,
                                                                   Settings settings,
                                                                   java.lang.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:
        java.lang.IllegalArgumentException - If the word list cannot be found at either key.
      • getWordList

        public static java.util.List<java.lang.String> getWordList​(Environment env,
                                                                   Settings settings,
                                                                   java.lang.String settingPath,
                                                                   java.lang.String settingList)
        Fetches a list of words from the specified settings file. The list should either be available at the key specified by settingList or in a file specified by settingPath.
        Throws:
        java.lang.IllegalArgumentException - If the word list cannot be found at either key.
      • loadWordList

        public static java.util.List<java.lang.String> loadWordList​(java.io.Reader reader,
                                                                    java.lang.String comment)
                                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • getReaderFromFile

        public static java.io.Reader getReaderFromFile​(Environment env,
                                                       Settings settings,
                                                       java.lang.String settingPrefix)
        Returns:
        null If no settings set for "settingsPrefix" then return null.
        Throws:
        java.lang.IllegalArgumentException - If the Reader can not be instantiated.