org.qedeq.kernel.dto.module
Class DefinitionVo

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

All Implemented Interfaces:

Definition, NodeType

public final class DefinitionVo

extends Object

implements Definition

Definition of operator. This might be a predicate or function constant. For example the predicate "x is a set" could be defined in MK with the formulaOrTerm \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.7 $

Constructor Summary

DefinitionVo()
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.
Definition	getDefinition() Get definition, if this is an instance of Definition.
LatexList	getDescription() Get description.
FormulaOrTerm	getFormulaOrTerm() Get formula or term that defines the object.
String	getLatexPattern() Get LaTeX output for definition.
Proposition	getProposition() Get proposition, if this is an instance of Proposition.
Rule	getRule() Get rule, if this is an instance of Rule.
String	getType() Get definition type.
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(LatexList description) Set description.
void	setFormulaOrTerm(FormulaOrTerm formulaOrTerm) Set defining formula or term that defines the object.
void	setLatexPattern(String latexPattern) Set LaTeX pattern for definition visualisation.
void	setType(String type) Set definition type.
void	setVariableList(VariableList 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

DefinitionVo

public DefinitionVo()

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.

getDefinition

public Definition getDefinition()

Description copied from interface: NodeType

Get definition, if this is an instance of Definition.

Specified by:

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

setType

public final void setType(String type)

Set definition type. For example: this a predicate definition, a function definition.

Parameters:

type - Definition type.

getType

public final String getType()

Description copied from interface: Definition

Get definition type. For example: this a predicate definition, a function definition.

Specified by:

getType in interface Definition

Returns:

Definition type.

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

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

Specified by:

getArgumentNumber in interface Definition

Returns:

Argument number.

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

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 Definition

Returns:

LaTeX pattern for definition type setting.

setVariableList

public final void setVariableList(VariableList 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: Definition

Get variable list of definition arguments.

Specified by:

getVariableList in interface Definition

Returns:

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

setFormulaOrTerm

public final void setFormulaOrTerm(FormulaOrTerm formulaOrTerm)

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

Parameters:

formulaOrTerm - Formula or term that defines the new operator.

getFormulaOrTerm

public final FormulaOrTerm getFormulaOrTerm()

Description copied from interface: Definition

Get formula or term that defines the object. Could be null.

Specified by:

getFormulaOrTerm in interface Definition

Returns:

Defining formula or term.

setDescription

public final void setDescription(LatexList description)

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

Parameters:

description - Description.

getDescription

public LatexList getDescription()

Description copied from interface: Definition

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

Specified by:

getDescription in interface Definition

Returns:

Description.

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

toString

public String toString()