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

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

All Implemented Interfaces:

FunctionDefinition, NodeType

public class FunctionDefinitionVo
extends java.lang.Object
implements FunctionDefinition

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

FunctionDefinitionVo()
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.
Formula	getFormula() Get defining formula for function constant.
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 FunctionDefinition.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	setFormula(Formula formula) Set defining formula for function constant.
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

FunctionDefinitionVo

public FunctionDefinitionVo()

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

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

Specified by:

getArgumentNumber in interface FunctionDefinition

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

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

Specified by:

getName in interface FunctionDefinition

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

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 FunctionDefinition

Returns:

LaTeX pattern for definition type setting.

getFormula

public final Formula getFormula()

Description copied from interface: FunctionDefinition

Get defining formula for function constant. This might be for example: f(x, y) = {z | z \in x & z \in y} Such a formula must have the equal operator as first operator. The first operand must be the function with free (and pairwise different) subject variables as arguments.

Specified by:

getFormula in interface FunctionDefinition

Returns:

Defining formula for function constant.

setFormula

public final void setFormula(Formula formula)

Set defining formula for function constant.

Parameters:

formula - Defining formula for function constant.

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

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

Specified by:

getDescription in interface FunctionDefinition

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