• Home
• com.github.szgabsz91
• morpher-language-handler-api
• 1.6.0-RC2
• source code
• ILanguageHandler.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.szgabsz91.morpher.languagehandlers.api.ILanguageHandler Maven / Gradle / Ivy

/*
 *                    GNU LESSER GENERAL PUBLIC LICENSE
 *                        Version 3, 29 June 2007
 *
 *  Copyright (C) 2007 Free Software Foundation, Inc. 
 *  Everyone is permitted to copy and distribute verbatim copies
 *  of this license document, but changing it is not allowed.
 *
 *
 *   This version of the GNU Lesser General Public License incorporates
 * the terms and conditions of version 3 of the GNU General Public
 * License, supplemented by the additional permissions listed below.
 *
 *   0. Additional Definitions.
 *
 *   As used herein, "this License" refers to version 3 of the GNU Lesser
 * General Public License, and the "GNU GPL" refers to version 3 of the GNU
 * General Public License.
 *
 *   "The Library" refers to a covered work governed by this License,
 * other than an Application or a Combined Work as defined below.
 *
 *   An "Application" is any work that makes use of an interface provided
 * by the Library, but which is not otherwise based on the Library.
 * Defining a subclass of a class defined by the Library is deemed a mode
 * of using an interface provided by the Library.
 *
 *   A "Combined Work" is a work produced by combining or linking an
 * Application with the Library.  The particular version of the Library
 * with which the Combined Work was made is also called the "Linked
 * Version".
 *
 *   The "Minimal Corresponding Source" for a Combined Work means the
 * Corresponding Source for the Combined Work, excluding any source code
 * for portions of the Combined Work that, considered in isolation, are
 * based on the Application, and not on the Linked Version.
 *
 *   The "Corresponding Application Code" for a Combined Work means the
 * object code and/or source code for the Application, including any data
 * and utility programs needed for reproducing the Combined Work from the
 * Application, but excluding the System Libraries of the Combined Work.
 *
 *   1. Exception to Section 3 of the GNU GPL.
 *
 *   You may convey a covered work under sections 3 and 4 of this License
 * without being bound by section 3 of the GNU GPL.
 *
 *   2. Conveying Modified Versions.
 *
 *   If you modify a copy of the Library, and, in your modifications, a
 * facility refers to a function or data to be supplied by an Application
 * that uses the facility (other than as an argument passed when the
 * facility is invoked), then you may convey a copy of the modified
 * version:
 *
 *    a) under this License, provided that you make a good faith effort to
 *    ensure that, in the event an Application does not supply the
 *    function or data, the facility still operates, and performs
 *    whatever part of its purpose remains meaningful, or
 *
 *    b) under the GNU GPL, with none of the additional permissions of
 *    this License applicable to that copy.
 *
 *   3. Object Code Incorporating Material from Library Header Files.
 *
 *   The object code form of an Application may incorporate material from
 * a header file that is part of the Library.  You may convey such object
 * code under terms of your choice, provided that, if the incorporated
 * material is not limited to numerical parameters, data structure
 * layouts and accessors, or small macros, inline functions and templates
 * (ten or fewer lines in length), you do both of the following:
 *
 *    a) Give prominent notice with each copy of the object code that the
 *    Library is used in it and that the Library and its use are
 *    covered by this License.
 *
 *    b) Accompany the object code with a copy of the GNU GPL and this license
 *    document.
 *
 *   4. Combined Works.
 *
 *   You may convey a Combined Work under terms of your choice that,
 * taken together, effectively do not restrict modification of the
 * portions of the Library contained in the Combined Work and reverse
 * engineering for debugging such modifications, if you also do each of
 * the following:
 *
 *    a) Give prominent notice with each copy of the Combined Work that
 *    the Library is used in it and that the Library and its use are
 *    covered by this License.
 *
 *    b) Accompany the Combined Work with a copy of the GNU GPL and this license
 *    document.
 *
 *    c) For a Combined Work that displays copyright notices during
 *    execution, include the copyright notice for the Library among
 *    these notices, as well as a reference directing the user to the
 *    copies of the GNU GPL and this license document.
 *
 *    d) Do one of the following:
 *
 *        0) Convey the Minimal Corresponding Source under the terms of this
 *        License, and the Corresponding Application Code in a form
 *        suitable for, and under terms that permit, the user to
 *        recombine or relink the Application with a modified version of
 *        the Linked Version to produce a modified Combined Work, in the
 *        manner specified by section 6 of the GNU GPL for conveying
 *        Corresponding Source.
 *
 *        1) Use a suitable shared library mechanism for linking with the
 *        Library.  A suitable mechanism is one that (a) uses at run time
 *        a copy of the Library already present on the user's computer
 *        system, and (b) will operate properly with a modified version
 *        of the Library that is interface-compatible with the Linked
 *        Version.
 *
 *    e) Provide Installation Information, but only if you would otherwise
 *    be required to provide such information under section 6 of the
 *    GNU GPL, and only to the extent that such information is
 *    necessary to install and execute a modified version of the
 *    Combined Work produced by recombining or relinking the
 *    Application with a modified version of the Linked Version. (If
 *    you use option 4d0, the Installation Information must accompany
 *    the Minimal Corresponding Source and Corresponding Application
 *    Code. If you use option 4d1, you must provide the Installation
 *    Information in the manner specified by section 6 of the GNU GPL
 *    for conveying Corresponding Source.)
 *
 *   5. Combined Libraries.
 *
 *   You may place library facilities that are a work based on the
 * Library side by side in a single library together with other library
 * facilities that are not Applications and are not covered by this
 * License, and convey such a combined library under terms of your
 * choice, if you do both of the following:
 *
 *    a) Accompany the combined library with a copy of the same work based
 *    on the Library, uncombined with any other library facilities,
 *    conveyed under the terms of this License.
 *
 *    b) Give prominent notice with the combined library that part of it
 *    is a work based on the Library, and explaining where to find the
 *    accompanying uncombined form of the same work.
 *
 *   6. Revised Versions of the GNU Lesser General Public License.
 *
 *   The Free Software Foundation may publish revised and/or new versions
 * of the GNU Lesser General Public License from time to time. Such new
 * versions will be similar in spirit to the present version, but may
 * differ in detail to address new problems or concerns.
 *
 *   Each version is given a distinguishing version number. If the
 * Library as you received it specifies that a certain numbered version
 * of the GNU Lesser General Public License "or any later version"
 * applies to it, you have the option of following the terms and
 * conditions either of that published version or of any later version
 * published by the Free Software Foundation. If the Library as you
 * received it does not specify a version number of the GNU Lesser
 * General Public License, you may choose any version of the GNU Lesser
 * General Public License ever published by the Free Software Foundation.
 *
 *   If the Library as you received it specifies that a proxy can decide
 * whether future versions of the GNU Lesser General Public License shall
 * apply, that proxy's public statement of acceptance of any version is
 * permanent authorization for you to choose that version for the
 * Library.
 */
package com.github.szgabsz91.morpher.languagehandlers.api;

import com.github.szgabsz91.morpher.core.model.AffixType;
import com.github.szgabsz91.morpher.languagehandlers.api.model.AffixTypeChain;
import com.github.szgabsz91.morpher.languagehandlers.api.model.AnnotationTokenizerResult;
import com.github.szgabsz91.morpher.languagehandlers.api.model.LanguageHandlerResponse;
import com.github.szgabsz91.morpher.languagehandlers.api.model.LemmaMap;
import com.github.szgabsz91.morpher.languagehandlers.api.model.ProbabilisticAffixType;
import com.github.szgabsz91.morpher.core.io.IConvertable;
import com.github.szgabsz91.morpher.core.io.ISavable;
import com.github.szgabsz91.morpher.core.model.FrequencyAwareWord;
import com.github.szgabsz91.morpher.core.model.Word;
import com.google.protobuf.GeneratedMessageV3;

import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Base interface for language handlers.
 *
 * @author szgabsz91
 * @param  the concrete type of message
 */
public interface ILanguageHandler extends AutoCloseable, ISavable, IConvertable {

    /**
     * Deletes temporary folders and files.
     */
    @Override
    void close();

    /**
     * Learns the given {@link AnnotationTokenizerResult}s.
     * @param annotationTokenizerResults the map of {@link AnnotationTokenizerResult}s for each affix type
     */
    void learnAnnotationTokenizerResults(Map> annotationTokenizerResults);

    /**
     * Learns the given {@link AffixType} chains.
     * @param affixTypeChains the set of {@link AffixType} chains
     */
    void learnAffixTypeChains(Set> affixTypeChains);

    /**
     * Adds the words in the given map to the set of known lemmas.
     * @param lemmaMap the lemma map
     */
    void learnLemmas(LemmaMap lemmaMap);

    /**
     * Analyzes the given word and returns new word pairs for affix types.
     * @param word the word to analyze
     * @return the response
     */
    LanguageHandlerResponse analyze(FrequencyAwareWord word);

    /**
     * Analyzes the given words and returns new word pairs for affix types.
     * @param words the words to analyze
     * @return the response
     */
    LanguageHandlerResponse analyze(Set words);

    /**
     * Returns the list of affix type candidates for the given affix types, sorted by relative frequency, in descending
     * order.
     *
     * @param affixTypes the list of previous affix types
     * @return the ordered list of candidates
     */
    List getAnalysisCandidates(List affixTypes);

    /**
     * Returns a {@link ProbabilisticAffixType} that has an ending affix type and the conditional probability of ending
     * the given chain.
     *
     * @param affixTypes the affix types found so far
     * @return a {@link ProbabilisticAffixType} containing the ending affix type and the conditional probability
     */
    ProbabilisticAffixType getEndingAnalysisCandidate(List affixTypes);

    /**
     * Returns the part of speech tag candidates of the given lemma and their probabilities.
     * @param lemma the lemma
     * @return the part of speech tags of the lemma and their probabilities, or an empty list
     */
    List getPOSCandidates(Word lemma);

    /**
     * Returns if the given tag is a part of speech tag or not.
     * @param tag the tag
     * @return true if the given tag is a part of speech tag, false otherwise
     */
    boolean isPOS(AffixType tag);

    /**
     * Returns if the order of affix types in the given chain is valid or not.
     * @param affixTypes the list of affix types to check
     * @return true if the affix type chain is valid, false otherwise
     */
    boolean isAffixTypeChainValid(List affixTypes);

    /**
     * Sorts the given set of affix types based on the previously learnt probabilities.
     * @param lemma the lemma
     * @param affixTypes the set of affix types to sort
     * @return the sorted list of affix types
     */
    List sortAffixTypes(Word lemma, Set affixTypes);

    /**
     * Creates a new {@link AffixTypeChain} containing the appropriate part of speech tag and the given list of affix
     * types, with the calculated local probabilities.
     *
     * @param affixTypes the affix types
     * @return the created {@link AffixTypeChain}
     */
    AffixTypeChain calculateProbabilities(List affixTypes);

    /**
     * Returns the list of supported affix types.
     * @return the list of supported affix types
     */
    List getSupportedAffixTypes();

}