Show Formula.java syntax highlighted
/*
* Formula.java
*
* Created on October 15, 2006, 11:04 PM
*
* Description: Formula is a formula 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 java.util.List;
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 Formula
*
* @author reed
*/
@Entity
@NamedQuery(name=Constants.QUERY_FIND_FORMULA_BY_FORMULA_STRING,
query="SELECT f FROM Formula f, FormulaInfo fi WHERE fi.formulaString = :formulaString AND fi.formula = f")
public class Formula extends AbstractTerm { // NOPMD
/**
* 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 formula information */
@OneToOne(fetch=FetchType.LAZY, mappedBy = "formula", cascade=CascadeType.ALL)
private FormulaInfo formulaInfo; // NOPMD
/** Creates a new instance of Formula. */
public Formula() {
super();
}
/** Creates a new instance of Formula.
*
* @param termList the list of terms that constitute this formula
* @param creator the creator
* @param creationPurpose the creation purpose
* @param creationTimePoint the creation time point
*/
public Formula(
final List<AbstractTerm> termList,
final AbstractReifiedTerm creator,
final AbstractReifiedTerm creationPurpose,
final TimePoint creationTimePoint) {
super();
//Preconditions
assert termList != null : "termList must not be null";
assert !termList.isEmpty() : "termList must not be empty";
formulaInfo = new FormulaInfo(
this,
termList,
creator,
creationPurpose,
creationTimePoint);
}
/** Gets the formula information.
*
* @return formula information
*/
public FormulaInfo getFormulaInfo() {
return formulaInfo;
}
/** Gets the formula string.
*
* @return the formula string
*/
public String getFormulaString() {
return getFormulaInfo().getFormulaString();
}
/** Returns this formula as a list of terms.
*
* @return this formula as a list of terms
*/
public List<AbstractTerm> getTermList() {
return getFormulaInfo().getTermList();
}
/** Gets the creator.
*
* @return the creator
*/
public AbstractReifiedTerm getCreator() {
return getFormulaInfo().getCreator();
}
/** Gets the creation purpose.
*
* @return the creation purpose
*/
public AbstractReifiedTerm getCreationPurpose() {
return getFormulaInfo().getCreationPurpose();
}
/** Gets the creation date.
*
* @return the creation date
*/
public TimePoint getCreationTimePoint() {
return getFormulaInfo().getCreationTimePoint();
}
/**
* Returns a hash code value for the object. This implementation computes
* a hash code value based on the unchanging formulaString.
* @return a hash code value for this object
*/
@Override
public int hashCode() {
return getFormulaInfo().hashCode();
}
/**
* Determines whether another object is equal to this AtomicTerm.
* @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 Formula)) {
return false;
}
final Formula that = (Formula) object;
return this.getFormulaInfo().getTermList().equals(that.getFormulaInfo().getTermList());
}
/** Returns a string representation of this object.
*
* @return a string representation of this object
*/
@Override
public String toString() {
return getFormulaInfo().toString();
}
/** Returns a CycL representation of this object.
*
* @return a CycL representation of this object
*/
public String toCycLString() {
return getFormulaInfo().toCycLString();
}
}
See more files for this project here