PCharacterInfo.java from Texai at Krugle

Show PCharacterInfo.java syntax highlighted

/*
 * PCharacterInfo.java
 *
 * Created on October 24, 2006, 1:56 PM
 *
 * Description: Contains the specialized fields for PCharacter.
 *
 * 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 java.io.Serializable;
import javax.persistence.Basic;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.OneToOne;
import javax.persistence.Transient;

/**
 * Entity class PCharacterInfo
 *
 * @author reed
 */
@Entity
public class PCharacterInfo implements Serializable {

  /**
   * 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 id */
  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private Long pCharacterInfoId;          // NOPMD

  /** the persistent character */
  @OneToOne
  private PCharacter pCharacter;          // NOPMD

  /** the character value */
  @Basic
  private Character characterValue;       // NOPMD

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

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

    this.pCharacter = pCharacter;
    this.characterValue = characterValue;
  }

  /**
   * Gets the id of this PCharacterInfo.
   *
   * @return the id
   */
  public Long getPCharacterInfoId() {
    return this.pCharacterInfoId;
  }

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

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

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

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

  /** gets the persistent character
   *
   * @return the persistent character
   */
  public PCharacter getPCharacter() {
    return pCharacter;
  }

}
See more files for this project here