org.qedeq.kernel.se.dto.module
Class SubstFuncVo

java.lang.Object
  org.qedeq.kernel.se.dto.module.SubstFuncVo

All Implemented Interfaces:

Reason, SubstFunc

public class SubstFuncVo
extends java.lang.Object
implements SubstFunc

Usage of rule for substitute function variable.

Author:

Michael Meyling

Constructor Summary

SubstFuncVo()
Default constructor.

SubstFuncVo(java.lang.String reference, Element functionVariable, Element substituteFormula)
Constructs an reason.

Method Summary

boolean	equals(java.lang.Object obj)
Element	getFunctionVariable() Get function variable (with subject variables as parameters) that should be replaced.
java.lang.String	getName() Get name for this reason.
java.lang.String	getReference() Get reference to already proven formula.
java.lang.String[]	getReferences() Get references to previous formulas.
SubstFunc	getSubstFunc() Get this reason.
Element	getSubstituteTerm() Get substitute term.
int	hashCode()
void	setFunctionVariable(Element functionVariable) Set function variable that will be substituted.
void	setReference(java.lang.String reference) Set formula reference.
void	setSubstituteTerm(Element substituteTerm) Set substitution term.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubstFuncVo

public SubstFuncVo(java.lang.String reference,
                   Element functionVariable,
                   Element substituteFormula)

Constructs an reason.

Parameters:

reference - Reference to a valid formula.

functionVariable - Function variable that will be substituted.

substituteFormula - Replacement term.

SubstFuncVo

public SubstFuncVo()

Default constructor.

Method Detail

getSubstFunc

public SubstFunc getSubstFunc()

Description copied from interface: SubstFunc

Get this reason.

Specified by:

getSubstFunc in interface SubstFunc

Returns:

This reason.

getReference

public java.lang.String getReference()

Description copied from interface: SubstFunc

Get reference to already proven formula.

Specified by:

getReference in interface SubstFunc

Returns:

Reference to previously proved formula.

setReference

public void setReference(java.lang.String reference)

Set formula reference.

Parameters:

reference - Reference to formula.

getReferences

public java.lang.String[] getReferences()

Description copied from interface: Reason

Get references to previous formulas.

Specified by:

getReferences in interface Reason

Returns:

List of references. Contains no entries with value null.

getFunctionVariable

public Element getFunctionVariable()

Description copied from interface: SubstFunc

Get function variable (with subject variables as parameters) that should be replaced.

Specified by:

getFunctionVariable in interface SubstFunc

Returns:

Function variable.

setFunctionVariable

public void setFunctionVariable(Element functionVariable)

Set function variable that will be substituted.

Parameters:

functionVariable - Function variable that will be replaced.

getSubstituteTerm

public Element getSubstituteTerm()

Description copied from interface: SubstFunc

Get substitute term. Must contain the subject variables from SubstFunc.getFunctionVariable().

Specified by:

getSubstituteTerm in interface SubstFunc

Returns:

Replacement term.

setSubstituteTerm

public void setSubstituteTerm(Element substituteTerm)

Set substitution term.

Parameters:

substituteTerm - New term.

getName

public java.lang.String getName()

Description copied from interface: Reason

Get name for this reason.

Specified by:

getName in interface Reason

Returns:

Name.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object