View Javadoc

1   package fr.ove.openmath.jome.model.processor;
2   
3   import fr.ove.openmath.jome.model.Formula;
4   
5   /***
6   * The interface to implement if a class wants to be considered
7   * as a processor of the model of the formula (@see fr.ove.openmath.jome.model.Formula)
8   *
9   * @author © 2000 DIRAT Laurent
10  * @version 1.0  16/08/2000
11  */
12  public interface Processor {
13      /***
14      * Does processing.
15      */
16      public void doProcess();
17      
18      /***
19      * Sets the formula to processs
20      */
21      public void setFormula(Formula formula);
22      
23      /***
24      * Returns the formula to process.
25      */
26      public Formula getFormula();
27      
28      /***
29      * Specifies if, after processing the formula, the display has to be
30      * updated.
31      * @param updateDisplay <CODE>true</CODE> if the display needs update.
32      * <CODE>false</CODE> otherwise.
33      */
34      public void setUpdateDisplay(boolean updateDisplay);
35      
36      /***
37      * Checks if, after processing the formula, the display has to be
38      * updated.
39      * @returns <CODE>true</CODE> if the display needs update.
40      * <CODE>false</CODE> otherwise.
41      */
42      public boolean getUpdateDisplay();
43      
44      /***
45      * Initialisation of the processor.
46      */
47      public void init();
48      
49      /***
50      * Sets the processing to execute.
51      * @param processingId the processing Id.
52      */
53      public void setProcessingId(int processingId);
54      
55      /***
56      * Returns the current processing to execute.
57      */
58      public int getProcessingId();
59      
60      /***
61      * Sets the level from which the processing starts.
62      * @param level the level.
63      */
64      public void setLevel(int level);
65      
66      /***
67      * Returns the level from which the processing starts.
68      */
69      public int getLevel();
70  }