|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PredicateDefinition | Line # 31 | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
No Tests | |||
1 | /* $Id: PredicateDefinition.java,v 1.4 2008/03/27 05:16:26 m31 Exp $ | |
2 | * | |
3 | * This file is part of the project "Hilbert II" - http://www.qedeq.org | |
4 | * | |
5 | * Copyright 2000-2008, Michael Meyling <mime@qedeq.org>. | |
6 | * | |
7 | * "Hilbert II" is free software; you can redistribute | |
8 | * it and/or modify it under the terms of the GNU General Public | |
9 | * License as published by the Free Software Foundation; either | |
10 | * version 2 of the License, or (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | */ | |
17 | ||
18 | package org.qedeq.kernel.base.module; | |
19 | ||
20 | ||
21 | /** | |
22 | * Definition of operator. This is a predicate constant. For example the | |
23 | * predicate "x is a set" could be defined in MK with the formula "\exists y: x \in y". | |
24 | * <p> | |
25 | * There must also be the possibility to define basic predicate constants like | |
26 | * "x is element of y". | |
27 | * | |
28 | * @version $Revision: 1.4 $ | |
29 | * @author Michael Meyling | |
30 | */ | |
31 | public interface PredicateDefinition extends NodeType { | |
32 | ||
33 | /** | |
34 | * Get number of arguments for the defined object. Carries information about the argument | |
35 | * number the defined object needs. | |
36 | * | |
37 | * @return Argument number. | |
38 | */ | |
39 | public String getArgumentNumber(); | |
40 | ||
41 | /** | |
42 | * This name together with {@link #getArgumentNumber()} identifies a predicate. | |
43 | * | |
44 | * @return Name of defined predicate. | |
45 | */ | |
46 | public String getName(); | |
47 | ||
48 | /** | |
49 | * Get LaTeX output for definition. The replaceable arguments must are marked as "#1", | |
50 | * "#2" and so on. For example "\mathfrak{M}(#1)" | |
51 | * | |
52 | * @return LaTeX pattern for definition type setting. | |
53 | */ | |
54 | public String getLatexPattern(); | |
55 | ||
56 | /** | |
57 | * Get variable list of definition arguments. | |
58 | * | |
59 | * @return List of formulas or subject variables to be replaced in the LaTeX pattern. | |
60 | * Could be <code>null</code>. | |
61 | */ | |
62 | public VariableList getVariableList(); | |
63 | ||
64 | /** | |
65 | * Get term that defines the object. Could be <code>null</code>. | |
66 | * | |
67 | * @return Defining formula. | |
68 | */ | |
69 | public Formula getFormula(); | |
70 | ||
71 | /** | |
72 | * Get description. Only necessary if formula is not self-explanatory. | |
73 | * | |
74 | * @return Description. | |
75 | */ | |
76 | public LatexList getDescription(); | |
77 | ||
78 | } |
|