001 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
002 *
003 * Copyright 2000-2013, Michael Meyling <mime@qedeq.org>.
004 *
005 * "Hilbert II" is free software; you can redistribute
006 * it and/or modify it under the terms of the GNU General Public
007 * License as published by the Free Software Foundation; either
008 * version 2 of the License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU General Public License for more details.
014 */
015
016 package org.qedeq.kernel.se.dto.module;
017
018 import org.apache.commons.lang.ArrayUtils;
019 import org.qedeq.base.utility.EqualsUtility;
020 import org.qedeq.kernel.se.base.list.Element;
021 import org.qedeq.kernel.se.base.module.SubstPred;
022
023
024 /**
025 * Usage of rule for substitute predicate variable.
026 *
027 * @author Michael Meyling
028 */
029 public class SubstPredVo implements SubstPred {
030
031 /** Reference to previously proven formula. */
032 private String reference;
033
034 /** Function variable that will be substituted. */
035 private Element predicateVariable;
036
037 /** Replacement formula. */
038 private Element substituteFormula;
039
040 /**
041 * Constructs an reason.
042 *
043 * @param reference Reference to a valid formula.
044 * @param predicateVariable Predicate variable that will be substituted.
045 * @param substituteFormula Replacement formula.
046 */
047
048 public SubstPredVo(final String reference, final Element predicateVariable,
049 final Element substituteFormula) {
050 this.reference = reference;
051 this.predicateVariable = predicateVariable;
052 this.substituteFormula = substituteFormula;
053 }
054
055 /**
056 * Default constructor.
057 */
058 public SubstPredVo() {
059 // nothing to do
060 }
061
062 public SubstPred getSubstPred() {
063 return this;
064 }
065
066 public String getReference() {
067 return reference;
068 }
069
070 /**
071 * Set formula reference.
072 *
073 * @param reference Reference to formula.
074 */
075 public void setReference(final String reference) {
076 this.reference = reference;
077 }
078
079 public String[] getReferences() {
080 if (reference == null) {
081 return ArrayUtils.EMPTY_STRING_ARRAY;
082 }
083 return new String[] {reference };
084 }
085
086 public Element getPredicateVariable() {
087 return predicateVariable;
088 }
089
090 /**
091 * Set predicate variable that will be substituted.
092 *
093 * @param predicateVariable Function variable that will be replaced.
094 */
095 public void setPredicateVariable(final Element predicateVariable) {
096 this.predicateVariable = predicateVariable;
097 }
098
099 public Element getSubstituteFormula() {
100 return substituteFormula;
101 }
102
103 /**
104 * Set substitution formula.
105 *
106 * @param substituteFormula New formula.
107 */
108 public void setSubstituteFormula(final Element substituteFormula) {
109 this.substituteFormula = substituteFormula;
110 }
111
112 public String getName() {
113 return "SubstPred";
114 }
115
116 public boolean equals(final Object obj) {
117 if (!(obj instanceof SubstPred)) {
118 return false;
119 }
120 final SubstPred other = (SubstPred) obj;
121 return EqualsUtility.equals(getReference(), other.getReference())
122 && EqualsUtility.equals(predicateVariable, other.getPredicateVariable())
123 && EqualsUtility.equals(substituteFormula, other.getSubstituteFormula());
124 }
125
126 public int hashCode() {
127 return (getReference() != null ? getReference().hashCode() : 0)
128 ^ (getPredicateVariable() != null ? 2 ^ getPredicateVariable().hashCode() : 0)
129 ^ (getSubstituteFormula() != null ? 3 ^ getSubstituteFormula().hashCode() : 0);
130 }
131
132 public String toString() {
133 StringBuffer result = new StringBuffer();
134 result.append(getName());
135 if (getReference() != null || getPredicateVariable() != null
136 || getSubstituteFormula() != null) {
137 result.append(" (");
138 boolean w = false;
139 if (getReference() != null) {
140 result.append(getReference());
141 w = true;
142 }
143 if (getPredicateVariable() != null) {
144 if (w) {
145 result.append(", ");
146 }
147 result.append(getPredicateVariable());
148 w = true;
149 }
150 if (getSubstituteFormula() != null) {
151 if (w) {
152 result.append(", ");
153 }
154 result.append("by ");
155 result.append(getSubstituteFormula());
156 w = true;
157 }
158 result.append(")");
159 }
160 return result.toString();
161 }
162
163 }
|