Package com.yahoo.searchdefinition.document

Enum Stemming

java.lang.Object

java.lang.Enum<Stemming>

com.yahoo.searchdefinition.document.Stemming

All Implemented Interfaces:

Serializable, Comparable<Stemming>

public enum Stemming
extends 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

Modifier and Type	Method	Description
static Stemming	get(String stemmingName)	Returns the stemming object for the given string.
String	getName()
com.yahoo.language.process.StemMode	toStemMode()
String	toString()
static Stemming	valueOf(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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public static Stemming get(String stemmingName)

Returns the stemming object for the given string. The legal stemming names are the stemming constants in any capitalization.

Throws:

IllegalArgumentException - if there is no stemming type with the given name

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<Stemming>

toStemMode

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