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

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

All Implemented Interfaces:

Node, SubsectionType

public class NodeVo
extends java.lang.Object
implements Node

Special subsection of a QEDEQ file.

Author:

Michael Meyling

Constructor Summary

NodeVo()
Constructs a new empty node.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getId() Get label of node.
java.lang.String	getLevel() Get level of node.
LatexList	getName() Set name of node.
Node	getNode() Get Node, if this is an instance of Node.
NodeType	getNodeType() Get node content.
LatexList	getPrecedingText() Get text before the formula.
Subsection	getSubsection() Get subsection, if this is an instance of Subsection.
LatexList	getSucceedingText() Get text after the formula.
LatexList	getTitle() Get title of subsection.
int	hashCode()
void	setId(java.lang.String id) Set label for this node.
void	setLevel(java.lang.String level) Set node level.
void	setName(LatexListVo name) Set node name.
void	setNodeType(NodeType nodeType) Set the concrete theorem or definition or else.
void	setPrecedingText(LatexListVo precedingText) Set preceding LaTeX text.
void	setSucceedingText(LatexListVo succeedingText) Set succeeding LaTeX text.
void	setTitle(LatexListVo title) Set node title.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeVo

public NodeVo()

Constructs a new empty node.

Method Detail

getNode

public Node getNode()

Description copied from interface: SubsectionType

Get Node, if this is an instance of Node.

Specified by:

getNode in interface SubsectionType

Returns:

Node, maybe null.

getSubsection

public Subsection getSubsection()

Description copied from interface: SubsectionType

Get subsection, if this is an instance of Subsection.

Specified by:

getSubsection in interface SubsectionType

Returns:

Subsection, maybe null.

setId

public final void setId(java.lang.String id)

Set label for this node. Referencing must use this label.

Parameters:

id - Label for referencing.

getId

public final java.lang.String getId()

Description copied from interface: Node

Get label of node. The node is referenced with this label.

Specified by:

getId in interface Node

Returns:

Returns the label.

setLevel

public final void setLevel(java.lang.String level)

Set node level.

Parameters:

level - Level of this node.

getLevel

public final java.lang.String getLevel()

Description copied from interface: Node

Get level of node. Higher levels contain additional informations.

Specified by:

getLevel in interface Node

Returns:

Returns the level.

setName

public final void setName(LatexListVo name)

Set node name. Could be used as an readable reference, e.g. "Axiom of Choice".

Parameters:

name - Name of this node.

getName

public final LatexList getName()

Description copied from interface: Node

Set name of node. Could be used as an readable reference, e.g. "Axiom of Choice".

Specified by:

getName in interface Node

Returns:

Returns the name.

setTitle

public final void setTitle(LatexListVo title)

Set node title.

Parameters:

title - Title of node.

getTitle

public final LatexList getTitle()

Description copied from interface: Node

Get title of subsection.

Specified by:

getTitle in interface Node

Returns:

Returns the name.

setPrecedingText

public final void setPrecedingText(LatexListVo precedingText)

Set preceding LaTeX text. This text comes before a theorem, definition etc. but belongs to this node regards content.

Parameters:

precedingText - Preceding LaTeX text.

getPrecedingText

public final LatexList getPrecedingText()

Description copied from interface: Node

Get text before the formula. Get the preceding LaTeX text. This text comes before a theorem, definition etc. but belongs to this node regards content.

Specified by:

getPrecedingText in interface Node

Returns:

Returns the preceding LaTeX text.

setNodeType

public final void setNodeType(NodeType nodeType)

Set the concrete theorem or definition or else.

Parameters:

nodeType - An instance of NodeType.

getNodeType

public final NodeType getNodeType()

Description copied from interface: Node

Get node content. This is for example a concrete theorem or definition. The main information of a node could be found here.

Specified by:

getNodeType in interface Node

Returns:

Returns the nodeType.

setSucceedingText

public final void setSucceedingText(LatexListVo succeedingText)

Set succeeding LaTeX text. This text comes after a theorem, definition etc. but belongs to this node regards content.

Parameters:

succeedingText - Succeeding LaTeX text.

getSucceedingText

public final LatexList getSucceedingText()

Description copied from interface: Node

Get text after the formula. Get the succeeding LaTeX text. This text comes after a theorem, definition etc. but belongs to this node regards content.

Specified by:

getSucceedingText in interface Node

Returns:

Returns the succeedingText.

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