PVariableInfo.java from Texai at Krugle

Show PVariableInfo.java syntax highlighted

/*
 * PVariableInfo.java
 *
 * Created on October 24, 2006, 1:57 PM
 *
 * Description: Contains the specialized fields for PVariable.
 *
 * 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 PVariableInfo
 *
 * @author reed
 */
@Entity
public class PVariableInfo 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 pVariableInfoId;             // NOPMD

  /** the persistent variable */
  @OneToOne
  private PVariable pVariable;              // NOPMD

  /** the name value */
  @Basic
  private String nameValue;                 // NOPMD

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

  /** Creates a new instance of PVariableInfo.
   *
   * @param pVariable the persistent variable
   * @param nameValue the name value
   */
  public PVariableInfo(final PVariable pVariable, final String nameValue) {
    super();
    //Preconditions
    assert pVariable != null : "pVariable must not be null";
    assert nameValue != null : "nameValue must not be null";
    assert nameValue.length() > 1 : "nameValue must be at least two characters long";
    assert nameValue.charAt(0) == '?' : "symbol must have a question mark as its first character " + nameValue;

    this.pVariable = pVariable;
    this.nameValue = nameValue;
  }

  /**
   * Gets the id of this PVariableInfo.
   *
   * @return the pVariableInfoId
   */
  public Long getPVariableInfoId() {
    return this.pVariableInfoId;
  }

  /**
   * Returns a hash code value for the object.
   *
   * @return a hash code value for this object.
   */
  @Override
  public int hashCode() {
    return nameValue.hashCode();
  }

  /**
   * Determines whether another object is equal to 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 PVariableInfo)) {
      return false;
    }
    final PVariableInfo that = (PVariableInfo) object;
    return this.nameValue.equals(that.nameValue);
  }

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

  /** Gets the persistent variable.
   *
   * @return the persistent variable
   */
  public PVariable getPVariable() {
    return pVariable;
  }

}
See more files for this project here