org.qedeq.kernel.base.module
Interface Definition

All Superinterfaces:

NodeType

All Known Implementing Classes:

DefinitionBo, DefinitionVo

public interface Definition

extends NodeType

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.6 $

Method Summary

String	getArgumentNumber() Get number of arguments for the defined object.
LatexList	getDescription() Get description.
FormulaOrTerm	getFormulaOrTerm() Get formula or term that defines the object.
String	getLatexPattern() Get LaTeX output for definition.
String	getType() Get definition type.
VariableList	getVariableList() Get variable list of definition arguments.

Methods inherited from interface org.qedeq.kernel.base.module.NodeType

getAxiom, getDefinition, getProposition, getRule

Method Detail

getType

public String getType()

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

Returns:

Definition type.

getArgumentNumber

public String getArgumentNumber()

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

Returns:

Argument number.

getLatexPattern

public String getLatexPattern()

Get LaTeX output for definition. The replaceable arguments must are marked as "#1", "#2" and so on. For example "\mathfrak{M}(#1)"

Returns:

LaTeX pattern for definition type setting.

getVariableList

public VariableList getVariableList()

Get variable list of definition arguments.

Returns:

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

getFormulaOrTerm

public FormulaOrTerm getFormulaOrTerm()

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

Returns:

Defining formula or term.

getDescription

public LatexList getDescription()

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

Returns:

Description.