ReferenceResolver.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2013,  Michael Meyling <mime@qedeq.org>.
04  *
05  * "Hilbert II" is free software; you can redistribute
06  * it and/or modify it under the terms of the GNU General Public
07  * License as published by the Free Software Foundation; either
08  * version 2 of the License, or (at your option) any later version.
09  *
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.bo.logic.common;
17 
18 import org.qedeq.kernel.se.base.list.Element;
19 import org.qedeq.kernel.se.common.ModuleContext;
20 
21 
22 /**
23  * Resolver for references from formal proof lines. Specific to a certain formal proof.
24  *
25  @author  Michael Meyling
26  */
27 public interface ReferenceResolver {
28 
29     /**
30      * Check if a reference is a proved formula.
31      *
32      @param   reference   Reference to axiom, definition or proposition.
33      @return  Reference has a proved formula.
34      */
35     public boolean isProvedFormula(String reference);
36 
37     /**
38      * Get reference formula in a normalized format.
39      *
40      @param   reference   Reference to axiom, definition or proposition.
41      @return  Already proved formula.
42      */
43     public Element getNormalizedReferenceFormula(String reference);
44 
45 
46     /**
47      * Get formula in a normalized format.
48      *
49      @param   element   Local formula to normalize.
50      @return  Normalized formula.
51      */
52     public Element getNormalizedFormula(Element element);
53 
54 
55     /**
56      * Is this a local proof line reference?
57      *
58      @param   reference   Local proof line reference to check for.
59      @return  Is this a local proof line reference for the caller?
60      */
61     public boolean isLocalProofLineReference(String reference);
62 
63     /**
64      * Get local for proof line reference.
65      *
66      @param   reference   Local proof line reference to check for.
67      @return  Local proof line for the caller. Might be <code>null</code>.
68      */
69     public Element getNormalizedLocalProofLineReference(String reference);
70 
71     /**
72      * Module context for proof line reference.
73      *
74      @param   reference   Local proof line reference to check for.
75      @return  Local proof line reference for the caller. Might be <code>null</code>.
76      */
77     public ModuleContext getReferenceContext(String reference);
78 
79 }