com.davidbracewell.hermes.wordnet.Synset Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hermes-wordnet Show documentation
A Natural Language Processing framework for Java
There is a newer version: 0.5
/*
 * (c) 2005 David B. Bracewell
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.davidbracewell.hermes.wordnet;

import com.davidbracewell.hermes.tag.POS;
import com.davidbracewell.hermes.wordnet.properties.Property;
import com.davidbracewell.hermes.wordnet.properties.PropertyName;
import com.davidbracewell.tuple.Tuple2;
import com.google.common.collect.HashMultimap;

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

/**
 * The interface Synset.
 *
 * @author David B. Bracewell
 */
public interface Synset {

  /**
   * Gets id.
   *
   * @return the id
   */
  String getId();

  /**
   * Gets senses.
   *
   * @return the senses
   */
  List getSenses();

  /**
   * Gets lexicographer file.
   *
   * @return the lexicographer file
   */
  LexicographerFile getLexicographerFile();

  /**
   * Gets pOS.
   *
   * @return the pOS
   */
  POS getPOS();

  /**
   * Gets gloss.
   *
   * @return the gloss
   */
  String getGloss();

  /**
   * Gets related synsets.
   *
   * @param relation the relation
   * @return the related synsets
   */
  Set getRelatedSynsets(WordNetRelation relation);

  /**
   * Gets related synsets.
   *
   * @return the related synsets
   */
  HashMultimap getRelatedSynsets();

  /**
   * Depth int.
   *
   * @return the int
   */
  int depth();

  /**
   * Is adjective satelitie.
   *
   * @return the boolean
   */
  boolean isAdjectiveSatelitie();


  default boolean isRoot() {
    return WordNet.getInstance().getRoots().contains(this);
  }


  default Synset getRoot() {
    if (isRoot()) {
      return this;
    }
    return WordNet.getInstance().getRoots().stream()
      .map(root -> Tuple2.of(root, WordNet.getInstance().distance(this, root)))
      .filter(tuple -> Double.isFinite(tuple.getV2()))
      .sorted(Map.Entry.comparingByValue())
      .findFirst()
      .map(Tuple2::getV1)
      .orElse(this);
  }


  default Synset getHypernym() {
    return WordNet.getInstance().getHypernym(this);
  }

  default Set getHyponyms() {
    return WordNet.getInstance().getHyponyms(this);
  }

   T getProperty(PropertyName name);


}//END OF Synset