[GitHub] [lucene] rmuir commented on a change in pull request #297: LUCENE-10102: Add JapaneseCompletionFilter for Input Method-aware auto-completion

[GitBox <gi...@apache.org>]

rmuir commented on a change in pull request #297:
URL: https://github.com/apache/lucene/pull/297#discussion_r709105732



##########
File path: lucene/analysis/kuromoji/src/resources/org/apache/lucene/analysis/ja/completion/romaji_map.txt
##########
@@ -0,0 +1,335 @@
+ア,a

Review comment:
       Should we add a line of logic to `KatakanaRomanizer` to discard lines beginning with `#`? It would allow to put some comments in this file, which might help keep it tidy.
   
   maybe something like:
   ```
   # mapping of kana to list of acceptable romanizations
   # longest-match is used to find entries in this list
   # covers romanization systems: X, Y, Z
   ```

##########
File path: lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseCompletionAnalyzer.java
##########
@@ -0,0 +1,70 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.analysis.ja;
+
+import java.io.Reader;
+import org.apache.lucene.analysis.Analyzer;
+import org.apache.lucene.analysis.TokenStream;
+import org.apache.lucene.analysis.Tokenizer;
+import org.apache.lucene.analysis.cjk.CJKWidthCharFilter;
+import org.apache.lucene.analysis.core.LowerCaseFilter;
+import org.apache.lucene.analysis.ja.dict.UserDictionary;
+
+/**
+ * Analyzer for Japanese completion suggester.
+ *
+ * @see JapaneseCompletionFilter
+ */
+public class JapaneseCompletionAnalyzer extends Analyzer {
+  private final JapaneseCompletionFilter.Mode mode;
+  private final UserDictionary userDict;
+
+  /** Creates a new {@code JapaneseCompletionAnalyzer} with default configurations */
+  public JapaneseCompletionAnalyzer() {
+    this(null, JapaneseCompletionFilter.Mode.INDEX);
+  }
+
+  /** Creates a new {@code JapaneseCompletionAnalyzer} */
+  public JapaneseCompletionAnalyzer(UserDictionary userDict, JapaneseCompletionFilter.Mode mode) {
+    this.userDict = userDict;
+    this.mode = mode;
+  }
+
+  @Override
+  protected TokenStreamComponents createComponents(String fieldName) {
+    Tokenizer tokenizer =
+        new JapaneseTokenizer(userDict, true, true, JapaneseTokenizer.Mode.NORMAL);
+    TokenStream stream = new JapaneseCompletionFilter(tokenizer, mode);
+    return new TokenStreamComponents(tokenizer, stream);
+  }
+
+  @Override
+  protected TokenStream normalize(String fieldName, TokenStream in) {
+    TokenStream result = new LowerCaseFilter(in);
+    return result;
+  }

Review comment:
       what's the LowerCaseFilter do here? Should we just return `in`, given that this filter is not really used in `createComponents?`

##########
File path: lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/completion/StringUtils.java
##########
@@ -0,0 +1,104 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.analysis.ja.completion;
+
+import org.apache.lucene.util.CharsRef;
+
+/** Utility functions for {@link org.apache.lucene.analysis.ja.JapaneseCompletionFilter} */
+public class StringUtils {

Review comment:
       Some methods in this file take `String`, others take `CharsRef`. But for the most part, the methods here only need `charAt` and `length`. Should we change signatures to use `CharSequence`, which is implemented by both `String` and `CharsRef`?
   
   P.S. I think it could also reduce some copying/conversion if we look into this elsewhere in the logic of this filter too.
   
   * https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org