ProofFinder.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.proof.common;
17 
18 import org.qedeq.base.io.Parameters;
19 import org.qedeq.kernel.bo.common.Element2Utf8;
20 import org.qedeq.kernel.bo.log.ModuleLogListener;
21 import org.qedeq.kernel.se.base.list.Element;
22 import org.qedeq.kernel.se.base.module.FormalProofLineList;
23 import org.qedeq.kernel.se.common.ModuleContext;
24 import org.qedeq.kernel.se.visitor.InterruptException;
25 
26 /**
27  * A proof finder can create formal proofs for propositions.
28  *
29  @author  Michael Meyling
30  */
31 public interface ProofFinder {
32 
33     /**
34      * Finds a formal proof.
35      *
36      @param   formula             Formula we want to proof.
37      @param   proof               Initial proof lines containing only "Add" lines.
38      @param   context             We are in this context.
39      @param   parameters          Further parameters to tune search process.
40      @param   log                 Log progress.
41      @param   transform           Transformer for getting UTF-8 out of elements.
42      @throws  InterruptException  Proof finding was interrupted.
43      @throws  ProofException      Finding result.
44      */
45     public void findProof(Element formula, FormalProofLineList proof,
46             ModuleContext context, Parameters parameters, ModuleLogListener log,
47             Element2Utf8 transform)
48             throws InterruptException, ProofException;
49 
50     /**
51      * Get a description which action is currently taken.
52      *
53      @return  Description.
54      */
55     public String getExecutionActionDescription();
56 
57 }