@@ -73,6 +73,12 @@ public AnalysisRegistry(Environment environment,
7373 this .analyzers = unmodifiableMap (analyzers );
7474 }
7575
76+ /**
77+ * Returns a {@link Settings} by groupName from {@link IndexSettings} or a default {@link Settings}
78+ * @param indexSettings an index settings
79+ * @param groupName tokenizer/token filter/char filter name
80+ * @return {@link Settings}
81+ */
7682 public static Settings getSettingsFromIndexSettings (IndexSettings indexSettings , String groupName ) {
7783 Settings settings = indexSettings .getSettings ().getAsSettings (groupName );
7884 if (settings .isEmpty ()) {
@@ -154,7 +160,14 @@ public AnalysisService build(IndexSettings indexSettings) throws IOException {
154160 return new AnalysisService (indexSettings , analyzierFactories , tokenizerFactories , charFilterFactories , tokenFilterFactories );
155161 }
156162
157-
163+ /**
164+ * Returns a registered {@link TokenizerFactory} provider by {@link IndexSettings}
165+ * or a registered {@link TokenizerFactory} provider by predefined name
166+ * or <code>null</code> if the tokenizer was not registered
167+ * @param tokenizer global or defined tokenizer name
168+ * @param indexSettings an index settings
169+ * @return {@link TokenizerFactory} provider or <code>null</code>
170+ */
158171 public AnalysisProvider <TokenizerFactory > getTokenizerProvider (String tokenizer , IndexSettings indexSettings ) {
159172 final Map <String , Settings > tokenizerSettings = indexSettings .getSettings ().getGroups ("index.analysis.tokenizer" );
160173 if (tokenizerSettings .containsKey (tokenizer )) {
@@ -165,6 +178,14 @@ public AnalysisProvider<TokenizerFactory> getTokenizerProvider(String tokenizer,
165178 }
166179 }
167180
181+ /**
182+ * Returns a registered {@link TokenFilterFactory} provider by {@link IndexSettings}
183+ * or a registered {@link TokenFilterFactory} provider by predefined name
184+ * or <code>null</code> if the tokenFilter was not registered
185+ * @param tokenFilter global or defined tokenFilter name
186+ * @param indexSettings an index settings
187+ * @return {@link TokenFilterFactory} provider or <code>null</code>
188+ */
168189 public AnalysisProvider <TokenFilterFactory > getTokenFilterProvider (String tokenFilter , IndexSettings indexSettings ) {
169190 final Map <String , Settings > tokenFilterSettings = indexSettings .getSettings ().getGroups ("index.analysis.filter" );
170191 if (tokenFilterSettings .containsKey (tokenFilter )) {
@@ -185,6 +206,14 @@ public AnalysisProvider<TokenFilterFactory> getTokenFilterProvider(String tokenF
185206 }
186207 }
187208
209+ /**
210+ * Returns a registered {@link CharFilterFactory} provider by {@link IndexSettings}
211+ * or a registered {@link CharFilterFactory} provider by predefined name
212+ * or <code>null</code> if the charFilter was not registered
213+ * @param charFilter global or defined charFilter name
214+ * @param indexSettings an index settings
215+ * @return {@link CharFilterFactory} provider or <code>null</code>
216+ */
188217 public AnalysisProvider <CharFilterFactory > getCharFilterProvider (String charFilter , IndexSettings indexSettings ) {
189218 final Map <String , Settings > tokenFilterSettings = indexSettings .getSettings ().getGroups ("index.analysis.char_filter" );
190219 if (tokenFilterSettings .containsKey (charFilter )) {
0 commit comments