WordNetSentencePattern.java from Texai at Krugle

Show WordNetSentencePattern.java syntax highlighted

/*
 * WordNetSentencePattern.java
 *
 * Created on November 21, 2006, 9:51 AM
 *
 * Description: Contains a WordNet sentence pattern that applies to specified word senses.
 *
 * 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;

/** Contains a WordNet sentence pattern that applies to specified word senses.  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="texai:org.texai.wordnet.domain.entity.WordNetSentencePattern", type="cyc:LinguisticObjectType", subClassOf="cyc:AbstractInformationStructure", context=Constants.TERM_WORDNET21_DOMAIN_CONTEXT)
@NotThreadSafe  // but effectively immutable
public class WordNetSentencePattern {
  
  /** the id assigned by the persistence framework */
  @Id
  private URI id;                                          // NOPMD
  
  /** the sentence pattern id */
  @RDFProperty(predicate="texai:wnWordNetSentencePatternId")
  private int wnWordNetSentencePatternId;                  // NOPMD

  /** the sentence pattern */
  @RDFProperty(predicate="texai:wnSentencePatternString")
  private String wnSentencePatternString;                  // NOPMD
  
  /** the set of word senses */
  @RDFProperty(predicate="texai:wnSentencePattern", inverse=true)
  private Set<WordNetWordSense> wnWordSenses;  
  
  /** Creates a new instance of WordNetSentencePattern. */
  public WordNetSentencePattern() {
    super();
  }

  /**
   * Creates a new instance of WordNetSentencePattern. 
   * 
   * @param wnWordNetSentencePatternId the sentence pattern id
   * @param wnwnSentencePatternStringhe sentence pattern
   */
  public WordNetSentencePattern(final int wnWordNetSentencePatternId, final String wnSentencePatternString) {
    super();
    //Preconditions
    assert wnWordNetSentencePatternId > 0 : "wnWordNetSentencePatternId must be positive";
    assert wnSentencePatternString != null : "wnSentencePatternString must not be null";
    assert !wnSentencePatternString.isEmpty() : "wnSentencePatternString must not be an empty string";
    assert wnSentencePatternString.contains("%s") : "wnSentencePatternString must contain the substitution variable";
    
    this.wnWordNetSentencePatternId = wnWordNetSentencePatternId;
    this.wnSentencePatternString = wnSentencePatternString;
  }

  /** 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 WordNetSentencePattern)) {
      return false;
    }
    final WordNetSentencePattern that = (WordNetSentencePattern) object;
    return this.getId().equals(that.getId());
  }

  /** Gets the id.
   *
   * @return the id
   */
  public URI getId() {
    return id;
  }
  
  /** Gets the sentence pattern id.
   *
   * @return the sentence pattern id
   */
  public int getWNWordNetSentencePatternId() {
    return wnWordNetSentencePatternId;
  }

  /** Gets the sentence pattern.
   *
   * @return the sentence pattern
   */
  public String getWNSentencePatternString() {
    return wnSentencePatternString;
  }
  
  /** Gets the set of word senses.
   *
   * @return the set of word senses
   */
  public Set<WordNetWordSense> getWNWordSenses() {
    return wnWordSenses;
  }
  
}
See more files for this project here