1 /* This file is part of the project "Hilbert II" - http://www.qedeq.org" target="alexandria_uri">http://www.qedeq.org
2 *
3 * Copyright 2000-2014, Michael Meyling <mime@qedeq.org>.
4 *
5 * "Hilbert II" is free software; you can redistribute
6 * it and/or modify it under the terms of the GNU General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 */
15
16 package org.qedeq.kernel.se.base.module;
17
18
19 /**
20 * A node carries mathematical knowledge.
21 *
22 * @author Michael Meyling
23 */
24 public interface Node extends SubsectionType {
25
26 /**
27 * Get label of node. The node is referenced with this label.
28 *
29 * @return Returns the label.
30 */
31 public String getId();
32
33 /**
34 * Get level of node. Higher levels contain additional informations.
35 *
36 * @return Returns the level.
37 */
38 public String getLevel();
39
40 /**
41 * Set name of node. Could be used as an readable reference, e.g. "Axiom of Choice".
42 *
43 * @return Returns the name.
44 */
45 public LatexList getName();
46
47 /**
48 * Get title of subsection.
49 *
50 * @return Returns the name.
51 */
52 public LatexList getTitle();
53
54 /**
55 * Get text before the formula. Get the preceding LaTeX text. This text comes before a
56 * theorem, definition etc. but belongs to this node regards content.
57 *
58 * @return Returns the preceding LaTeX text.
59 */
60 public LatexList getPrecedingText();
61
62 /**
63 * Get node content. This is for example a concrete theorem or definition. The main
64 * information of a node could be found here.
65 *
66 * @return Returns the nodeType.
67 */
68 public NodeType getNodeType();
69
70 /**
71 * Get text after the formula. Get the succeeding LaTeX text. This text comes after
72 * a theorem, definition etc. but belongs to this node regards content.
73 *
74 * @return Returns the succeedingText.
75 */
76 public LatexList getSucceedingText();
77
78 }