Hilbert II - Version 0.03.04

org.qedeq.kernel.dto.module
Class PredicateDefinitionVo

java.lang.Object
  extended byorg.qedeq.kernel.dto.module.PredicateDefinitionVo
All Implemented Interfaces:
NodeType, PredicateDefinition

public class PredicateDefinitionVo
extends Object
implements PredicateDefinition

Definition of operator. This is a predicate constant. For example the predicate "x is a set" could be defined in MK with the formula "\exists y: x \in y".

There must also be the possibility to define basic predicate constants like "x is element of y".

Version:
$Revision: 1.4 $

Constructor Summary
PredicateDefinitionVo()
          Constructs a new definition.
 
Method Summary
 boolean equals(Object obj)
           
 String getArgumentNumber()
          Get number of arguments for the defined object.
 Axiom getAxiom()
          Get axiom, if this is an instance of Axiom.
 LatexList getDescription()
          Get description.
 Formula getFormula()
          Get term that defines the object.
 FunctionDefinition getFunctionDefinition()
          Get definition, if this is an instance of FunctionDefinition.
 String getLatexPattern()
          Get LaTeX output for definition.
 String getName()
          This name together with getArgumentNumber() identifies a predicate.
 PredicateDefinition getPredicateDefinition()
          Get definition, if this is an instance of PredicateDefinition.
 Proposition getProposition()
          Get proposition, if this is an instance of Proposition.
 Rule getRule()
          Get rule, if this is an instance of Rule.
 VariableList getVariableList()
          Get variable list of definition arguments.
 int hashCode()
           
 void setArgumentNumber(String argumentNumber)
          Set information about the argument number the defined object needs.
 void setDescription(LatexListVo description)
          Set description.
 void setFormula(FormulaVo formulaOrTerm)
          Set defining formula or term that defines the object.
 void setLatexPattern(String latexPattern)
          Set LaTeX pattern for definition visualisation.
 void setName(String name)
          Set predicate name.
 void setVariableList(VariableListVo variables)
          Set list of formula or subject variables to be replaced in the LaTeX pattern.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PredicateDefinitionVo

public PredicateDefinitionVo()
Constructs a new definition.

Method Detail

getAxiom

public Axiom getAxiom()
Description copied from interface: NodeType
Get axiom, if this is an instance of Axiom.

Specified by:
getAxiom in interface NodeType
Returns:
Axiom, maybe null.

getPredicateDefinition

public PredicateDefinition getPredicateDefinition()
Description copied from interface: NodeType
Get definition, if this is an instance of PredicateDefinition.

Specified by:
getPredicateDefinition in interface NodeType
Returns:
Definition, maybe null.

getFunctionDefinition

public FunctionDefinition getFunctionDefinition()
Description copied from interface: NodeType
Get definition, if this is an instance of FunctionDefinition.

Specified by:
getFunctionDefinition in interface NodeType
Returns:
Definition, maybe null.

getProposition

public Proposition getProposition()
Description copied from interface: NodeType
Get proposition, if this is an instance of Proposition.

Specified by:
getProposition in interface NodeType
Returns:
Proposition, maybe null.

getRule

public Rule getRule()
Description copied from interface: NodeType
Get rule, if this is an instance of Rule.

Specified by:
getRule in interface NodeType
Returns:
Rule, maybe null.

setArgumentNumber

public final void setArgumentNumber(String argumentNumber)
Set information about the argument number the defined object needs.

Parameters:
argumentNumber - Argument number information.

getArgumentNumber

public final String getArgumentNumber()
Description copied from interface: PredicateDefinition
Get number of arguments for the defined object. Carries information about the argument number the defined object needs.

Specified by:
getArgumentNumber in interface PredicateDefinition
Returns:
Argument number.

setName

public void setName(String name)
Set predicate name. Together with getArgumentNumber() this identifies a predicate.

Parameters:
name -

getName

public String getName()
Description copied from interface: PredicateDefinition
This name together with PredicateDefinition.getArgumentNumber() identifies a predicate.

Specified by:
getName in interface PredicateDefinition
Returns:
Name of defined predicate.

setLatexPattern

public final void setLatexPattern(String latexPattern)
Set LaTeX pattern for definition visualisation. The replaceable arguments are marked as #1, #2 and so on. For example \mathfrak{M}(#1).

Parameters:
latexPattern - LaTeX pattern for definition visualisation.

getLatexPattern

public final String getLatexPattern()
Description copied from interface: PredicateDefinition
Get LaTeX output for definition. The replaceable arguments must are marked as "#1", "#2" and so on. For example "\mathfrak{M}(#1)"

Specified by:
getLatexPattern in interface PredicateDefinition
Returns:
LaTeX pattern for definition type setting.

setVariableList

public final void setVariableList(VariableListVo variables)
Set list of formula or subject variables to be replaced in the LaTeX pattern. Could be null.

Parameters:
variables - Variable list for replacement.

getVariableList

public final VariableList getVariableList()
Description copied from interface: PredicateDefinition
Get variable list of definition arguments.

Specified by:
getVariableList in interface PredicateDefinition
Returns:
List of formulas or subject variables to be replaced in the LaTeX pattern. Could be null.

setFormula

public final void setFormula(FormulaVo formulaOrTerm)
Set defining formula or term that defines the object. Could be null.

Parameters:
formulaOrTerm - Formula or term that defines the new operator.

getFormula

public final Formula getFormula()
Description copied from interface: PredicateDefinition
Get term that defines the object. Could be null.

Specified by:
getFormula in interface PredicateDefinition
Returns:
Defining formula.

setDescription

public final void setDescription(LatexListVo description)
Set description. Only necessary if formula is not self-explanatory.

Parameters:
description - Description.

getDescription

public LatexList getDescription()
Description copied from interface: PredicateDefinition
Get description. Only necessary if formula is not self-explanatory.

Specified by:
getDescription in interface PredicateDefinition
Returns:
Description.

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

toString

public String toString()

Hilbert II - Version 0.03.04

©left GNU General Public Licence
All Rights Reserved.