org.qedeq.kernel.base.module
Interface PredicateDefinition

All Superinterfaces:

NodeType

All Known Implementing Classes:

PredicateDefinitionVo

public interface PredicateDefinition

extends NodeType

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

Method Summary

String	getArgumentNumber() Get number of arguments for the defined object.
LatexList	getDescription() Get description.
Formula	getFormula() Get term that defines the object.
String	getLatexPattern() Get LaTeX output for definition.
String	getName() This name together with getArgumentNumber() identifies a predicate.
VariableList	getVariableList() Get variable list of definition arguments.

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

getAxiom, getFunctionDefinition, getPredicateDefinition, getProposition, getRule

Method Detail

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.

getName

public String getName()

This name together with getArgumentNumber() identifies a predicate.

Returns:

Name of defined predicate.

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.

getFormula

public Formula getFormula()

Get term that defines the object. Could be null.

Returns:

Defining formula.

getDescription

public LatexList getDescription()

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

Returns:

Description.