WordNetEnglishWord.java from Texai at Krugle

Show WordNetEnglishWord.java syntax highlighted

/*
 * WordNetEnglishWord.java
 *
 * Created on November 10, 2006, 10:30 AM
 *
 * Description: WordNet word RDF entity.
 *
 * Copyright (C) 2006 Stephen L. Reed.
 *
 * This program is free software; you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

package org.texai.wordnet.domain.entity;

import java.util.Set;
import javax.persistence.Id;
import net.jcip.annotations.NotThreadSafe;
import org.openrdf.model.URI;
import org.texai.kb.Constants;
import org.texai.kb.persistence.RDFProperty;
import org.texai.kb.persistence.RDFEntity;
import org.texai.kb.persistence.RDFNamespace;

/** WordNet word RDF entity.  This class is not technically thread safe, but client applications should
 * treat it as immutable once loaded.  The field setter methods should not be used nor should the field
 * contents be modified.
 *
 * @author reed
 */
@RDFEntity(
namespaces={
  @RDFNamespace(prefix="texai", namespaceURI=Constants.TEXAI_NAMESPACE),
  @RDFNamespace(prefix="cyc", namespaceURI=Constants.CYC_NAMESPACE)},
subject="cyc:WordNetEnglishWord", context=Constants.TERM_WORDNET21_DOMAIN_CONTEXT)
@NotThreadSafe  // but effectively immutable
public class WordNetEnglishWord {
  
  /** the id assigned by the persistence framework */
  @Id
  private URI id;                                          // NOPMD
  
  /** the word id */
  @RDFProperty(predicate="texai:wnWordId")
  private int wnWordId;                                    // NOPMD
  
  /** the lemma */
  @RDFProperty(predicate="texai:wnLemma")
  private String wnLemma;                                  // NOPMD
  
  /** the word senses */
  @RDFProperty(predicate="texai:wnWordSenseWord", inverse=true)
  private Set<WordNetWordSense> wnWordSenses;
  
  /** the morphological variations */
  @RDFProperty(predicate="texai:wnWordForMorph", inverse=true)
  private Set<WordNetEnglishWordMorph> wnWordMorphs;

  /** Creates a new instance of WordNetEnglishWord */
  public WordNetEnglishWord() {
    super();
  }
  
  /**
   * Creates a new instance of WordNetEnglishWord.
   * 
   * @param wnWordId the word id
   * @param lemma the lemma
   */
  public WordNetEnglishWord(final int wnWordId, final String wnLemma) {
    super();
    //Preconditions
    assert wnWordId >= 0 : "wnWordId must be positive";
    assert wnLemma != null : "wnLemma must not be null";
    
    this.wnWordId = wnWordId;
    this.wnLemma = wnLemma;
  }
  
  /** Returns a hash code value for the object.
   *
   * @return a hash code value for this object.
   */
  @Override
  public int hashCode() {
    return getId().hashCode();
  }

  /** Determines whether another object is equal to this WordNetSynset.
   * 
   * @param object the reference object with which to compare
   * @return <code>true</code> if this object is the same as the argument;
   * <code>false</code> otherwise.
   */
  @Override
  public boolean equals(final Object object) {
    if (!(object instanceof WordNetEnglishWord)) {
      return false;
    }
    final WordNetEnglishWord that = (WordNetEnglishWord) object;
    return this.getId().equals(that.getId());
  }

  /** Gets the id.
   *
   * @return the id
   */
  public URI getId() {
    return id;
  }
  
  /** Gets the word id.
   *
   * @return the word id
   */
  public long getWNWordId() {
    return wnWordId;
  }

  /** Gets the lemma.
   *
   * @return the lemma
   */
  public String getWNLemma() {
    return wnLemma;
  }
  
  /** Gets the word senses.
   *
   * @return the word senses
   */
  public Set<WordNetWordSense> getWNWordSenses() {
    return wnWordSenses;
  }
  
  /** Gets the word morphs.
   *
   * @return the word morphs
   */
  public Set<WordNetEnglishWordMorph> getWNWordMorphs() {
    return wnWordMorphs;
  }
  
  /** Returns a string representation of the object.
   *
   * @return a string representation of the object.
   */
  @Override
  public String toString() {
    return "[word: " + wnLemma + "]";
  }
  
}
See more files for this project here