org.nlpub.watset.util.IndexedSense Maven / Gradle / Ivy

Go to download

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

An open source implementation of the Watset algorithm for fuzzy graph clustering.

The newest version!

/*
 * Copyright 2018 Dmitry Ustalov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.nlpub.watset.util;

import org.jgrapht.alg.util.Pair;

import java.util.Locale;

import static java.util.Objects.requireNonNull;

/**
 * An integer sense identifier.
 *
 * @param  the type of value
 */
public class IndexedSense extends Pair implements Sense {
    /**
     * Create a sense of an object.
     *
     * @param value the object
     * @param sense the sense identifier
     */
    public IndexedSense(V value, Integer sense) {
        super(value, requireNonNull(sense));
    }

    @Override
    public V get() {
        return first;
    }

    /**
     * Get the sense identifier.
     *
     * @return the sense identifier
     */
    public Integer getSense() {
        return second;
    }

    @Override
    public String toString() {
        return String.format(Locale.ROOT, "%s#%d", first, second);
    }
}