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

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

All Implemented Interfaces:

InitialPredicateDefinition, NodeType

public class InitialPredicateDefinitionVo
extends java.lang.Object
implements InitialPredicateDefinition

Definition of initial operator. This is a given predicate constant. For example: "x is element of y".

Author:

Michael Meyling

Constructor Summary

InitialPredicateDefinitionVo()
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.
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 InitialPredicateDefinition.getArgumentNumber() identifies a predicate.
Element	getPredCon() Get new predicate constant with free subject variables.
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	setLatexPattern(java.lang.String latexPattern) Set LaTeX pattern for definition visualisation.
void	setName(java.lang.String name) Set predicate name.
void	setPredCon(Element predCon) Set new predicate constant with free subject variables.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InitialPredicateDefinitionVo

public InitialPredicateDefinitionVo()

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

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

Specified by:

getArgumentNumber in interface InitialPredicateDefinition

Returns:

Argument number.

setName

public void setName(java.lang.String name)

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

Parameters:

name - Predicate name.

getName

public java.lang.String getName()

Description copied from interface: InitialPredicateDefinition

This name together with InitialPredicateDefinition.getArgumentNumber() identifies a predicate.

Specified by:

getName in interface InitialPredicateDefinition

Returns:

Name of defined predicate.

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

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 InitialPredicateDefinition

Returns:

LaTeX pattern for definition type setting.

setPredCon

public final void setPredCon(Element predCon)

Set new predicate constant with free subject variables. The predicate constant must match getName() and getArgumentNumber().

Parameters:

predCon - Predicate constant with free subject variables.

getPredCon

public final Element getPredCon()

Description copied from interface: InitialPredicateDefinition

Get new predicate constant with free subject variables. The predicate constant must match InitialPredicateDefinition.getName() and InitialPredicateDefinition.getArgumentNumber().

Specified by:

getPredCon in interface InitialPredicateDefinition

Returns:

Predicate constant with free subject variables.

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

Get description. Optional.

Specified by:

getDescription in interface InitialPredicateDefinition

Returns:

Description. Might be null.

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