org.qedeq.kernel.dto.module
Class FunctionDefinitionVo

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

All Implemented Interfaces:

FunctionDefinition, NodeType

public final class FunctionDefinitionVo

extends 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.

Version:

$Revision: 1.1 $

Constructor Summary

FunctionDefinitionVo()
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.
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 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.
Term	getTerm() Get term that defines the object.
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	setLatexPattern(String latexPattern) Set LaTeX pattern for definition visualisation.
void	setName(String name) Set function name.
void	setTerm(TermVo term) Set defining term that defines the object.
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

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.

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: 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(String name)

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

Parameters:

name -

getName

public 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(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: 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.

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

Get variable list of definition arguments.

Specified by:

getVariableList in interface FunctionDefinition

Returns:

List of formulas or subject variables to be replaced in the LaTeX pattern. Could be null.

setTerm

public final void setTerm(TermVo term)

Set defining term that defines the object. Could be null.

Parameters:

term - Term that defines the new operator.

getTerm

public final Term getTerm()

Description copied from interface: FunctionDefinition

Get term that defines the object. Could be null.

Specified by:

getTerm in interface FunctionDefinition

Returns:

Defining term.

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(Object obj)

hashCode

public int hashCode()

toString

public String toString()