Package com.yahoo.searchdefinition.document

Enum Stemming

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Stemming>
    public enum Stemming
extends java.lang.Enum<Stemming>

    The stemming setting of a field. This describes how the search engine should transform content of this field into base forms (stems) to increase recall (find "car" when you search for "cars" etc.).

    Author:
    bratseth

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BEST
      select the "best" stem alternative
      MULTIPLE
      index multiple stems
      NONE
      No stemming
      SHORTEST
      select shortest possible stem

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Stemming get​(java.lang.String stemmingName)
      Returns the stemming object for the given string.
      java.lang.String getName()  
      com.yahoo.language.process.StemMode toStemMode()  
      java.lang.String toString()  
      static Stemming valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Stemming[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NONE

        public static final Stemming NONE
        No stemming

      • SHORTEST

        public static final Stemming SHORTEST
        select shortest possible stem

      • BEST

        public static final Stemming BEST
        select the "best" stem alternative

      • MULTIPLE

        public static final Stemming MULTIPLE
        index multiple stems

    • Method Detail

      • values

        public static Stemming[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Stemming c : Stemming.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Stemming valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • get

        public static Stemming get​(java.lang.String stemmingName)
        Returns the stemming object for the given string. The legal stemming names are the stemming constants in any capitalization.
        Throws:
        java.lang.IllegalArgumentException - if there is no stemming type with the given name

      • getName

        public java.lang.String getName()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Stemming>

      • toStemMode

        public com.yahoo.language.process.StemMode toStemMode()