com.yahoo.language.process.Stemmer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of linguistics Show documentation

There is a newer version: 8.441.21

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.language.process;

import com.yahoo.language.Language;

import java.util.List;

/**
 * Interface providing stemming of single words.
 *
 * @author Mathias Mølster Lidal
 */
public interface Stemmer {

    /**
     * Stem input according to specified stemming mode.
     * This default implementation invokes stem(input, mode, language) and so ignores the removeAccents argument.
     *
     * @param input    the string to stem.
     * @param language the language to use for stemming
     * @param mode     the stemming mode
     * @param removeAccents whether to normalize accents and similar
     * @return a list of possible stems. Empty if none.
     * @throws ProcessingException thrown if there is an exception stemming this input
     */
    default List stem(String input, Language language, StemMode mode, boolean removeAccents) {
        return stem(input, mode, language);
    }

    /**
     * Stem input according to specified stemming mode.
     *
     * @param input    the string to stem.
     * @param mode     the stemming mode
     * @param language the language to use for stemming
     * @return a list of possible stems. Empty if none.
     * @throws ProcessingException thrown if there is an exception stemming this input
     */
    List stem(String input, StemMode mode, Language language);

}