org.tendiwa.inflectible.GmWithSimilarity.java Source code

Introduction

Here is the source code for org.tendiwa.inflectible.GmWithSimilarity.java

Source

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Georgy Vlasov
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.tendiwa.inflectible;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;

/**
 * Decorator {@link GrammaticalMeaning} that can tell how similar it is to
 * another GrammaticalMeaning.
 * @author Georgy Vlasov (suseika@tendiwa.org)
 * @version $Id$
 * @since 0.2.0
 */
public final class GmWithSimilarity implements GrammaticalMeaning {
    /**
     * Decorated grammatical meaning.
     */
    private final transient GrammaticalMeaning wrapped;

    /**
     * Ctor.
     * @param grammemes Grammatical meaning
     */
    public GmWithSimilarity(final GrammaticalMeaning grammemes) {
        this.wrapped = grammemes;
    }

    @Override
    public ImmutableSet<Grammeme> grammemes() throws Exception {
        return this.wrapped.grammemes();
    }

    /**
     * Tells many grammemes this grammatical meaning has in common with
     * another one.
     * @param another Another grammatial meaning
     * @return The number of grammemes this grammatical meaning has in common
     *  with another one
     * @throws Exception If couldn't compute similarity
     */
    public int similarity(final GrammaticalMeaning another) throws Exception {
        return Sets.intersection(this.wrapped.grammemes(), another.grammemes()).size();
    }
}