ProofFinder.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2011,  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.base.module.FormalProofLineList;
20 import org.qedeq.kernel.se.common.ModuleContext;
21 import org.qedeq.kernel.se.visitor.InterruptException;
22 
23 /**
24  * A proof finder can create formal proofs for propositions.
25  *
26  @author  Michael Meyling
27  */
28 public interface ProofFinder {
29 
30     /**
31      * Finds a formal proof.
32      *
33      @param   formula             Formula we want to proof.
34      @param   proof               Initial proof lines containing only "Add" lines.
35      @param   context             We are in this context.
36      @throws  InterruptException  Proof finding was interrupted.
37      @return  Created formal proof. <code>null</code> if we did not find one.
38      */
39     public FormalProofLineList findProof(Element formula, FormalProofLineList proof,
40             ModuleContext contextthrows InterruptException;
41 
42     /**
43      * Get a description which action is currently taken.
44      *
45      @return  Description.
46      */
47     public String getExecutionActionDescription();
48 
49 }