LUCENE-8778: Define analyzer SPI names as static final fields and doc…

…ument the names in all analysis components. This also changes SPI loader to detect service names via the static NAME fields instead of class names.

.gitignore

@@ -28,3 +28,4 @@ pom.xml
 .pydevproject
 __pycache__
 /dev-tools/scripts/scripts.iml
+

lucene/CHANGES.txt

@@ -30,6 +30,8 @@ Bug fixes
 Other
 
 * LUCENE-8768: Fix Javadocs build in Java 11. (Namgyu Kim)
+* LUCENE-8778: Define analyzer SPI names as static final fields and document the names in Javadocs.
+  (Tomoko Uchida, Uwe Schindler)
 
 ======================= Lucene 8.2.0 =======================
 

lucene/analysis/common/src/java/org/apache/lucene/analysis/ar/ArabicNormalizationFilterFactory.java

@@ -33,9 +33,13 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class ArabicNormalizationFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "arabicNormalization";
+
   /** Creates a new ArabicNormalizationFilterFactory */
   public ArabicNormalizationFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/ar/ArabicStemFilterFactory.java

@@ -34,9 +34,13 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class ArabicStemFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "arabicStem";
+
   /** Creates a new ArabicStemFilterFactory */
   public ArabicStemFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/bg/BulgarianStemFilterFactory.java

@@ -33,9 +33,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class BulgarianStemFilterFactory extends TokenFilterFactory {
-
+
+  /** SPI name */
+  public static final String NAME = "bulgarianStem";
+
   /** Creates a new BulgarianStemFilterFactory */
   public BulgarianStemFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/bn/BengaliNormalizationFilterFactory.java

@@ -32,9 +32,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 7.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class BengaliNormalizationFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "bengaliNormalization";
+
   public BengaliNormalizationFilterFactory(Map<String,String> args) {
     super(args);
     if (!args.isEmpty()) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/bn/BengaliStemFilterFactory.java

@@ -32,9 +32,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 7.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class BengaliStemFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "bengaliStem";
+
   public BengaliStemFilterFactory(Map<String,String> args) {
     super(args);
     if (!args.isEmpty()) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/br/BrazilianStemFilterFactory.java

@@ -34,8 +34,12 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class BrazilianStemFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "brazilianStem";
 
   /** Creates a new BrazilianStemFilterFactory */
   public BrazilianStemFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilterFactory.java

@@ -35,8 +35,13 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class HTMLStripCharFilterFactory extends CharFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "htmlStrip";
+
   final Set<String> escapedTags;
   static final Pattern TAG_NAME_PATTERN = Pattern.compile("[^\\s,]+");
 

lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/MappingCharFilterFactory.java

@@ -40,10 +40,14 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since Solr 1.4
+ * @lucene.spi {@value #NAME}
  */
 public class MappingCharFilterFactory extends CharFilterFactory implements
     ResourceLoaderAware {
 
+  /** SPI name */
+  public static final String NAME = "mapping";
+
   protected NormalizeCharMap normMap;
   private final String mapping;
 

lucene/analysis/common/src/java/org/apache/lucene/analysis/cjk/CJKBigramFilterFactory.java

@@ -36,8 +36,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.6.0
+ * @lucene.spi {@value #NAME}
  */
 public class CJKBigramFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "cjkBigram";
+
   final int flags;
   final boolean outputUnigrams;
 

lucene/analysis/common/src/java/org/apache/lucene/analysis/cjk/CJKWidthFilterFactory.java

@@ -34,8 +34,12 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.6.0
+ * @lucene.spi {@value #NAME}
  */
 public class CJKWidthFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "cjkWidth";
 
   /** Creates a new CJKWidthFilterFactory */
   public CJKWidthFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/ckb/SoraniNormalizationFilterFactory.java

@@ -32,9 +32,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 4.7.0
+ * @lucene.spi {@value #NAME}
  */
 public class SoraniNormalizationFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "soraniNormalization";
+
   /** Creates a new SoraniNormalizationFilterFactory */
   public SoraniNormalizationFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/ckb/SoraniStemFilterFactory.java

@@ -33,9 +33,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 4.7.0
+ * @lucene.spi {@value #NAME}
  */
 public class SoraniStemFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "soraniStem";
+
   /** Creates a new SoraniStemFilterFactory */
   public SoraniStemFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/commongrams/CommonGramsFilterFactory.java

@@ -39,9 +39,14 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class CommonGramsFilterFactory extends TokenFilterFactory implements ResourceLoaderAware {
-  // TODO: shared base class for Stop/Keep/CommonGrams? 
+
+  /** SPI name */
+  public static final String NAME = "commonGrams";
+
+  // TODO: shared base class for Stop/Keep/CommonGrams?
   private CharArraySet commonWords;
   private final String commonWordFiles;
   private final String format;

lucene/analysis/common/src/java/org/apache/lucene/analysis/commongrams/CommonGramsQueryFilterFactory.java

@@ -34,9 +34,12 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class CommonGramsQueryFilterFactory extends CommonGramsFilterFactory {
 
+  public static final String NAME = "commonGramsQuery";
+
   /** Creates a new CommonGramsQueryFilterFactory */
   public CommonGramsQueryFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilterFactory.java

@@ -38,8 +38,13 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class DictionaryCompoundWordTokenFilterFactory extends TokenFilterFactory implements ResourceLoaderAware {
+
+  /** SPI name */
+  public static final String NAME = "dictionaryCompoundWord";
+
   private CharArraySet dictionary;
   private final String dictFile;
   private final int minWordSize;

lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilterFactory.java

@@ -58,8 +58,13 @@
  *
  * @see HyphenationCompoundWordTokenFilter
  * @since 3.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class HyphenationCompoundWordTokenFilterFactory extends TokenFilterFactory implements ResourceLoaderAware {
+
+  /** SPI name */
+  public static final String NAME = "hyphenationCompoundWord";
+
   private CharArraySet dictionary;
   private HyphenationTree hyphenator;
   private final String dictFile;

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/DecimalDigitFilterFactory.java

@@ -32,8 +32,12 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 5.4.0
+ * @lucene.spi {@value #NAME}
  */
 public class DecimalDigitFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "decimalDigit";
 
   /** Creates a new DecimalDigitFilterFactory */
   public DecimalDigitFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/FlattenGraphFilterFactory.java

@@ -27,9 +27,13 @@
  *
  * @lucene.experimental
  * @since 6.4.0
+ * @lucene.spi {@value #NAME}
  */
 public class FlattenGraphFilterFactory extends TokenFilterFactory {
 
+  /** SPI name */
+  public static final String NAME = "flattenGraph";
+
   /** Creates a new FlattenGraphFilterFactory */
   public FlattenGraphFilterFactory(Map<String,String> args) {
     super(args);

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/KeywordTokenizerFactory.java

@@ -40,8 +40,13 @@
  * </ul>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class KeywordTokenizerFactory extends TokenizerFactory {
+
+  /** SPI name */
+  public static final String NAME = "keyword";
+
   private final int maxTokenLen;
 
   /** Creates a new KeywordTokenizerFactory */

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/LetterTokenizerFactory.java

@@ -42,8 +42,13 @@
  * </ul>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class LetterTokenizerFactory extends TokenizerFactory {
+
+  /** SPI name */
+  public static final String NAME = "letter";
+
   private final int maxTokenLen;
 
   /** Creates a new LetterTokenizerFactory */

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/LowerCaseFilterFactory.java

@@ -33,8 +33,12 @@
  * &lt;/fieldType&gt;</pre>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class LowerCaseFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "lowercase";
 
   /** Creates a new LowerCaseFilterFactory */
   public LowerCaseFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/StopFilterFactory.java

@@ -71,8 +71,13 @@
  * </ul>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class StopFilterFactory extends TokenFilterFactory implements ResourceLoaderAware {
+
+  /** SPI name */
+  public static final String NAME = "stop";
+
   public static final String FORMAT_WORDSET = "wordset";
   public static final String FORMAT_SNOWBALL = "snowball";
 

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/TypeTokenFilterFactory.java

@@ -39,8 +39,13 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.6.0
+ * @lucene.spi {@value #NAME}
  */
 public class TypeTokenFilterFactory extends TokenFilterFactory implements ResourceLoaderAware {
+
+  /** SPI name */
+  public static final String NAME = "type";
+
   private final boolean useWhitelist;
   private final String stopTypesFiles;
   private Set<String> stopTypes;

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/UpperCaseFilterFactory.java

@@ -37,8 +37,12 @@
  * when you require uppercase tokens.  Use the {@link LowerCaseFilterFactory} for 
  * general search matching
  * @since 4.7.0
+ * @lucene.spi {@value #NAME}
  */
 public class UpperCaseFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "uppercase";
 
   /** Creates a new UpperCaseFilterFactory */
   public UpperCaseFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/core/WhitespaceTokenizerFactory.java

@@ -47,8 +47,13 @@
  * </ul>
  *
  * @since 3.1
+ * @lucene.spi {@value #NAME}
  */
 public class WhitespaceTokenizerFactory extends TokenizerFactory {
+
+  /** SPI name */
+  public static final String NAME = "whitespace";
+
   public static final String RULE_JAVA = "java";
   public static final String RULE_UNICODE = "unicode";
   private static final Collection<String> RULE_NAMES = Arrays.asList(RULE_JAVA, RULE_UNICODE);

lucene/analysis/common/src/java/org/apache/lucene/analysis/cz/CzechStemFilterFactory.java

@@ -33,8 +33,12 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class CzechStemFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "czechStem";
 
   /** Creates a new CzechStemFilterFactory */
   public CzechStemFilterFactory(Map<String,String> args) {

lucene/analysis/common/src/java/org/apache/lucene/analysis/de/GermanLightStemFilterFactory.java

@@ -33,8 +33,12 @@
  *   </analyzer>
  * &lt;/fieldType&gt;</pre>
  * @since 3.1.0
+ * @lucene.spi {@value #NAME}
  */
 public class GermanLightStemFilterFactory extends TokenFilterFactory {
+
+  /** SPI name */
+  public static final String NAME = "germanLightStem";
 
   /** Creates a new GermanLightStemFilterFactory */
   public GermanLightStemFilterFactory(Map<String,String> args) {