AtomicTermInfo.java from Texai at Krugle
Show AtomicTermInfo.java syntax highlighted
/*
* AtomicTermInfo.java
*
* Created on October 24, 2006, 1:44 PM
*
* Description: Contains the specialized fields for AtomicTerm.
*
* 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 java.util.UUID;
import javax.persistence.Basic;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.ManyToOne;
import javax.persistence.OneToOne;
import javax.persistence.Transient;
import org.texai.kb.Constants;
/**
* Entity class AtomicTermInfo
*
* @author reed
*/
@Entity
public class AtomicTermInfo 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 atomicTermInfoId; // NOPMD
/** the atomic term */
@OneToOne
private AtomicTerm atomicTerm; // NOPMD
/** the term name
* @serial
*/
@Basic
@Column(length=Constants.TERM_NAME_SIZE)
private String termName; // NOPMD
/** the pretty name
* @serial
*/
@Basic
private String prettyName; // NOPMD
/** the globally unique identifier (UUID) string
* @serial
*/
@Basic
private String uuid; // NOPMD
/** the creator of this atomic term */
@ManyToOne(optional=false, cascade=CascadeType.PERSIST, fetch=FetchType.LAZY)
private AbstractReifiedTerm creator;
/** the creation purpose of this atomic term */
@ManyToOne(optional=false, cascade=CascadeType.PERSIST, fetch=FetchType.LAZY)
private AbstractReifiedTerm creationPurpose;
/** the creation time point of this atomic term */
@ManyToOne(optional=false, cascade=CascadeType.PERSIST, fetch=FetchType.LAZY)
private TimePoint creationTimePoint;
/** Creates a new instance of AtomicTermInfo */
public AtomicTermInfo() {
super();
}
/** Creates a new instance of AtomicTermInfo.
*
* @param atomicTerm the atomic term
* @param termName the term name
* @param prettyName the pretty name
* @param uuid the uuid string
* @param creator the creator
* @param creationPurpose the creation purpose
* @param creationTimePoint the creation time point
*/
public AtomicTermInfo(
final AtomicTerm atomicTerm,
final String termName,
final String prettyName,
final String uuid,
final AbstractReifiedTerm creator,
final AbstractReifiedTerm creationPurpose,
final TimePoint creationTimePoint) {
super();
//Preconditions
assert atomicTerm != null : "atomicTerm must not be null";
assert termName != null : "termName must not be null";
assert termName.length() > 0 : "termName must not be an empty string";
assert creationTimePoint != null : "creationTimePoint must not be null";
this.atomicTerm = atomicTerm;
this.termName = termName;
this.prettyName = prettyName;
if (uuid == null) {
this.uuid = UUID.randomUUID().toString();
} else {
this.uuid = uuid;
}
this.creator = creator;
this.creationPurpose = creationPurpose;
this.creationTimePoint = creationTimePoint;
}
/**
* Gets the id of this AtomicTermInfo.
*
* @return the id
*/
public Long getAtomicTermId() {
return atomicTermInfoId;
}
/** Gets the atomic term
*
* @return the atomic term
*/
public AtomicTerm getAtomicTerm() {
return atomicTerm;
}
/** Returns term name.
*
* @return the term name
*/
public String getTermName() {
return termName;
}
/** Sets the term name.
*
* @param termName the term name
*/
public void setTermName(final String termName) {
assert termName != null : "termName must not be null";
assert termName.length() > 0 : "termName must not be an empty string";
this.termName = termName;
}
/** Returns the pretty name.
*
* @return the pretty name
*/
public String getPrettyName() {
return prettyName;
}
/** Sets the pretty name.
*
* @param prettyName the pretty name
*/
public void setPrettyName(final String prettyName) {
this.prettyName = prettyName;
}
/** Returns the uuid string.
*
* @return the uuid string
*/
public String getUuid() {
return uuid;
}
/** Gets the creator.
*
* @return the creator
*/
public AbstractReifiedTerm getCreator() {
return creator;
}
/** Gets the creation purpose.
*
* @return the creation purpose
*/
public AbstractReifiedTerm getCreationPurpose() {
return creationPurpose;
}
/** Gets the creation time point.
*
* @return the creation time point
*/
public TimePoint getCreationTimePoint() {
return creationTimePoint;
}
/**
* Returns a hash code value for the object. This implementation computes
* a hash code value based on the unchanging termName.
* @return a hash code value for this object
*/
@Override
public int hashCode() {
return termName.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 AtomicTermInfo)) {
return false;
}
final AtomicTermInfo that = (AtomicTermInfo) object;
return this.termName.equals(that.termName);
}
/** Returns a string representation of this object.
*
* @return a string representation of this object
*/
@Override
public String toString() {
return getTermName();
}
/** Returns a CycL representation of this object.
*
* @return a CycL representation of this object
*/
public String toCycLString() {
return "#$" + getTermName();
}
/** Gets the id */
public Long getAtomicTermInfoId() {
return atomicTermInfoId;
}
}
See more files for this project here