PCharacter.java from Texai at Krugle

Show PCharacter.java syntax highlighted

/*
 * PCharacter.java
 *
 * Created on October 16, 2006, 12:56 PM
 *
 * Description: PCharacter is a character term in the Texai logical representation language.
 *
 * 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.kb.ejb.entity;

import javax.persistence.CascadeType;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.Transient;
import org.texai.kb.Constants;

/**
 * Entity class PCharacter
 *
 * @author reed
 */
@Entity
@NamedQuery(name=Constants.QUERY_FIND_PCHARACTER_BY_CHARACTER_VALUE,
query="SELECT c FROM PCharacter c, PCharacterInfo ci WHERE ci.characterValue = :characterValue AND ci.pCharacter = c")
public class PCharacter extends AbstractTerm {

  /**
   * Determines if a de-serialized file is compatible with this class.
   *
   * Maintainers must change this value if and only if the new version
   * of this class is not compatible with old versions. See Sun docs
   * for <a href=http://java.sun.com/products/jdk/1.1/docs/guide
   * /serialization/spec/version.doc.html> details. </a>
   *
   * Not necessary to include in first version of the class, but
   * included here as a reminder of its importance.
   */
  @Transient
  private static final long serialVersionUID = 1L;

  /** the presistent character information */
  @OneToOne(fetch=FetchType.LAZY, mappedBy = "pCharacter", cascade=CascadeType.ALL)
  private PCharacterInfo pCharacterInfo;          // NOPMD

  /** Creates a new instance of PCharacter */
  public PCharacter() {
    super();
  }

  /** Creates a new instance of PCharacter.
   *
   * @param characterValue the character value
   */
  public PCharacter(final Character characterValue) {
    super();
    //Preconditions
    assert characterValue != null : "characterValue must not be null";

    pCharacterInfo = new PCharacterInfo(this, characterValue);
  }

  /** Gets the presistent character information.
   *
   * @return presistent character information
   */
  public PCharacterInfo getPCharacterInfo() {
    return pCharacterInfo;
  }

  /** Gets the character value.
   *
   * @return the character value
   */
  public Character getCharacterValue() {
    return getPCharacterInfo().getCharacterValue();
  }

  /**
   * Returns a hash code value for the object.  This implementation computes
   * a hash code value based on the unchanging longValue.
   * @return a hash code value for this object
   */
  @Override
  public int hashCode() {
    return getPCharacterInfo().hashCode();
  }

  /**
   * Determines whether another object is equal to this AtomicTerm.  The result is
   * <code>true</code> if and only if the argument is not null and is a AtomicTerm object that
   * has the same id field values as this object.
   * @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 PCharacter)) {
      return false;
    }
    final PCharacter that = (PCharacter) object;
    return this.getCharacterValue().equals(that.getCharacterValue());
  }

  /** Returns a string representation of this object.
   *
   * @return a string representation of this object
   */
  @Override
  public String toString() {
    return getPCharacterInfo().toString();
  }

  /** Returns a CycL representation of this object.
   *
   * @return a CycL representation of this object
   */
  public String toCycLString() {
    return getPCharacterInfo().toCycLString();
  }

}
See more files for this project here