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

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

All Implemented Interfaces:

InitialFunctionDefinition, NodeType

public class InitialFunctionDefinitionVo
extends java.lang.Object
implements InitialFunctionDefinition

Definition of function operator. This is a function constant. For example the function "x union y" or constants like the empty set.

Author:

Michael Meyling

Constructor Summary

InitialFunctionDefinitionVo()
Constructs a new definition.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.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.
Element	getFunCon() Get function constant that we define.
FunctionDefinition	getFunctionDefinition() Get definition, if this is an instance of FunctionDefinition.
InitialFunctionDefinition	getInitialFunctionDefinition() Get definition, if this is an instance of InitialFunctionDefinition.
InitialPredicateDefinition	getInitialPredicateDefinition() Get initial definition, if this is an instance of InitialPredicateDefinition.
java.lang.String	getLatexPattern() Get LaTeX output for definition.
java.lang.String	getName() This name together with InitialFunctionDefinition.getArgumentNumber() identifies a function.
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.
int	hashCode()
void	setArgumentNumber(java.lang.String argumentNumber) Set information about the argument number the defined object needs.
void	setDescription(LatexListVo description) Set description.
void	setFunCon(Element funCon) Set function constant that we define.
void	setLatexPattern(java.lang.String latexPattern) Set LaTeX pattern for definition visualisation.
void	setName(java.lang.String name) Set function name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InitialFunctionDefinitionVo

public InitialFunctionDefinitionVo()

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.

getInitialPredicateDefinition

public InitialPredicateDefinition getInitialPredicateDefinition()

Description copied from interface: NodeType

Get initial definition, if this is an instance of InitialPredicateDefinition.

Specified by:

getInitialPredicateDefinition in interface NodeType

Returns:

Definition, 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.

getInitialFunctionDefinition

public InitialFunctionDefinition getInitialFunctionDefinition()

Description copied from interface: NodeType

Get definition, if this is an instance of InitialFunctionDefinition.

Specified by:

getInitialFunctionDefinition 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(java.lang.String argumentNumber)

Set information about the argument number the defined object needs.

Parameters:

argumentNumber - Argument number information.

getArgumentNumber

public final java.lang.String getArgumentNumber()

Description copied from interface: InitialFunctionDefinition

Get number of arguments for the defined object. Carries information about the argument number the defined object needs.

Specified by:

getArgumentNumber in interface InitialFunctionDefinition

Returns:

Argument number.

setName

public void setName(java.lang.String name)

Set function name. Together with getArgumentNumber() this identifies a function.

Parameters:

name - Function name.

getName

public java.lang.String getName()

Description copied from interface: InitialFunctionDefinition

This name together with InitialFunctionDefinition.getArgumentNumber() identifies a function.

Specified by:

getName in interface InitialFunctionDefinition

Returns:

Name of defined function.

setLatexPattern

public final void setLatexPattern(java.lang.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 java.lang.String getLatexPattern()

Description copied from interface: InitialFunctionDefinition

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 InitialFunctionDefinition

Returns:

LaTeX pattern for definition type setting.

getFunCon

public Element getFunCon()

Description copied from interface: InitialFunctionDefinition

Get function constant that we define. The function constant must match InitialFunctionDefinition.getName() and InitialFunctionDefinition.getArgumentNumber().

Specified by:

getFunCon in interface InitialFunctionDefinition

Returns:

Function constant with free subject variables as arguments.

setFunCon

public void setFunCon(Element funCon)

Set function constant that we define. The function constant must match getName() and getArgumentNumber().

Parameters:

funCon - Function constant with free subject variables as arguments.

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: InitialFunctionDefinition

Get description. Only necessary if formula is not self-explanatory.

Specified by:

getDescription in interface InitialFunctionDefinition

Returns:

Description.

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