1.1 --- a/src/java/isac/util/interfaces/ICalcIterator.java Thu May 12 17:50:48 2005 +0200
1.2 +++ b/src/java/isac/util/interfaces/ICalcIterator.java Thu May 12 18:03:51 2005 +0200
1.3 @@ -42,176 +42,176 @@
1.4 */
1.5 public interface ICalcIterator extends Comparable, Cloneable, Remote {
1.6
1.7 - /**
1.8 - * get the marker 'Position' unique within a CalcTree (i.e. a CalcIterator)
1.9 - *
1.10 - * @return Position
1.11 - */
1.12 - public Position getPosition() throws RemoteException;
1.13 + /**
1.14 + * get the marker 'Position' unique within a CalcTree (i.e. a CalcIterator)
1.15 + *
1.16 + * @return Position
1.17 + */
1.18 + public Position getPosition() throws RemoteException;
1.19
1.20 - /**
1.21 - * Reference the first (root) element in the attached calculation tree.
1.22 - *
1.23 - * @return Like all the moveXXX methods this returns true on success, false
1.24 - * if there is no element to move to.
1.25 - */
1.26 - public boolean moveRoot() throws RemoteException;
1.27 + /**
1.28 + * Reference the first (root) element in the attached calculation tree.
1.29 + *
1.30 + * @return Like all the moveXXX methods this returns true on success, false
1.31 + * if there is no element to move to.
1.32 + */
1.33 + public boolean moveRoot() throws RemoteException;
1.34
1.35 - /**
1.36 - * Reference the next enclosing CalcHead element in the attached calculation
1.37 - * tree. This will be the subproblem being solved at the moment, or, if not
1.38 - * solving subproblems, the root problem of the calculation.
1.39 - *
1.40 - * @return Like all the moveXXX methods this returns true on success, false
1.41 - * if there is no element to move to.
1.42 - */
1.43 - public boolean moveCalcHead() throws RemoteException;
1.44 + /**
1.45 + * Reference the next enclosing CalcHead element in the attached calculation
1.46 + * tree. This will be the subproblem being solved at the moment, or, if not
1.47 + * solving subproblems, the root problem of the calculation.
1.48 + *
1.49 + * @return Like all the moveXXX methods this returns true on success, false
1.50 + * if there is no element to move to.
1.51 + */
1.52 + public boolean moveCalcHead() throws RemoteException;
1.53
1.54 - /**
1.55 - * Reference the previous formula in the attached calculation tree.
1.56 - *
1.57 - * @return Like all the moveXXX methods this returns true on success, false
1.58 - * if there is no element to move to.
1.59 - */
1.60 - public boolean moveUp() throws RemoteException;
1.61 + /**
1.62 + * Reference the previous formula in the attached calculation tree.
1.63 + *
1.64 + * @return Like all the moveXXX methods this returns true on success, false
1.65 + * if there is no element to move to.
1.66 + */
1.67 + public boolean moveUp() throws RemoteException;
1.68
1.69 - /**
1.70 - * Reference the next formula in the attached calculation tree.
1.71 - *
1.72 - * @return Like all the moveXXX methods this returns true on success, false
1.73 - * if there is no element to move to.
1.74 - *
1.75 - * moveRoot() plus moveDown() reaches all nodes in a CalcTree
1.76 - */
1.77 - public boolean moveDown() throws RemoteException;
1.78 + /**
1.79 + * Reference the next formula in the attached calculation tree.
1.80 + *
1.81 + * @return Like all the moveXXX methods this returns true on success, false
1.82 + * if there is no element to move to.
1.83 + *
1.84 + * moveRoot() plus moveDown() reaches all nodes in a CalcTree
1.85 + */
1.86 + public boolean moveDown() throws RemoteException;
1.87
1.88 - /**
1.89 - * Enter the next coarser level of refinement in the attached calculation
1.90 - * tree.
1.91 - *
1.92 - * @return Like all the moveXXX methods this returns true on success, false
1.93 - * if there is no element to move to.
1.94 - */
1.95 - public boolean moveLevelUp() throws RemoteException;
1.96 + /**
1.97 + * Enter the next coarser level of refinement in the attached calculation
1.98 + * tree.
1.99 + *
1.100 + * @return Like all the moveXXX methods this returns true on success, false
1.101 + * if there is no element to move to.
1.102 + */
1.103 + public boolean moveLevelUp() throws RemoteException;
1.104
1.105 - /**
1.106 - * Enter the next more detailed level of refinement in the attached
1.107 - * calculation tree.
1.108 - *
1.109 - * @return Like all the moveXXX methods this returns true on success, false
1.110 - * if there is no element to move to.
1.111 - */
1.112 - public boolean moveLevelDown() throws RemoteException;
1.113 + /**
1.114 + * Enter the next more detailed level of refinement in the attached
1.115 + * calculation tree.
1.116 + *
1.117 + * @return Like all the moveXXX methods this returns true on success, false
1.118 + * if there is no element to move to.
1.119 + */
1.120 + public boolean moveLevelDown() throws RemoteException;
1.121
1.122 - /**
1.123 - * Reference the formula which resulted in the currently selected element of
1.124 - * the attached calculation tree.
1.125 - */
1.126 - public boolean moveFormula() throws RemoteException;
1.127 + /**
1.128 + * Reference the formula which resulted in the currently selected element of
1.129 + * the attached calculation tree.
1.130 + */
1.131 + public boolean moveFormula() throws RemoteException;
1.132
1.133 - /**
1.134 - * Ask whether this is the last Item, which is equivalent to whwther there
1.135 - * is another item where moveDown() could move to.
1.136 - *
1.137 - * @return true, if moveDown() would not yield any new elements false, if
1.138 - * moveDown() would move to another element WN040819 awaiting
1.139 - * problems with parallel branches (OR, AND, etc.) in calcTree
1.140 - * @deprecated due to calcChangedEvent since 0512
1.141 - */
1.142 - public boolean isLast() throws RemoteException;
1.143 + /**
1.144 + * Ask whether this is the last Item, which is equivalent to whwther there
1.145 + * is another item where moveDown() could move to.
1.146 + *
1.147 + * @return true, if moveDown() would not yield any new elements false, if
1.148 + * moveDown() would move to another element WN040819 awaiting
1.149 + * problems with parallel branches (OR, AND, etc.) in calcTree
1.150 + * @deprecated due to calcChangedEvent since 0512
1.151 + */
1.152 + public boolean isLast() throws RemoteException;
1.153
1.154 - /**
1.155 - * is the Iterator on a CalcHead or not
1.156 - */
1.157 - public boolean onCalcHead() throws RemoteException;
1.158 + /**
1.159 + * is the Iterator on a CalcHead or not
1.160 + */
1.161 + public boolean onCalcHead() throws RemoteException;
1.162
1.163 - /**
1.164 - * Use this to get the current element and check the type by calling
1.165 - * getType().
1.166 - *
1.167 - * @return The currently referenced Element
1.168 - * @see #getType()
1.169 - * @deprecated due to getFormula, getTactic, getAssumption
1.170 - */
1.171 - public ICalcElement getElement() throws RemoteException;
1.172 + /**
1.173 + * Use this to get the current element and check the type by calling
1.174 + * getType().
1.175 + *
1.176 + * @return The currently referenced Element
1.177 + * @see #getType()
1.178 + * @deprecated due to getFormula, getTactic, getAssumption
1.179 + */
1.180 + public ICalcElement getElement() throws RemoteException;
1.181
1.182 - /**
1.183 - * @return Formula, which may also be a CalcHead !
1.184 - */
1.185 + /**
1.186 + * @return Formula, which may also be a CalcHead !
1.187 + */
1.188
1.189 - public ICalcElement getFormula() throws RemoteException;
1.190 + public ICalcElement getFormula() throws RemoteException;
1.191
1.192 - /**
1.193 - * @return Tactic applicable to the formula under the Iterator
1.194 - */
1.195 - public Tactic getTactic() throws RemoteException;
1.196 + /**
1.197 + * @return Tactic applicable to the formula under the Iterator
1.198 + */
1.199 + public Tactic getTactic() throws RemoteException;
1.200
1.201 - /**
1.202 - * Get a list of tactics applicable to the active formula.
1.203 - *
1.204 - * @param scope
1.205 - * WN0502 not yet impl. The filter parameter selects the scope of
1.206 - * search for applicable tactics.
1.207 - * @return Vector with applicable tactics
1.208 - * @see #TACTICS_ALL
1.209 - * @see #TACTICS_CURRENT_THEORY
1.210 - * @see #TACTICS_CURRENT_METHOD
1.211 - */
1.212 - public Vector getApplicableTactics(int scope) throws RemoteException;
1.213 + /**
1.214 + * Get a list of tactics applicable to the active formula.
1.215 + *
1.216 + * @param scope
1.217 + * WN0502 not yet impl. The filter parameter selects the scope of
1.218 + * search for applicable tactics.
1.219 + * @return Vector with applicable tactics
1.220 + * @see #TACTICS_ALL
1.221 + * @see #TACTICS_CURRENT_THEORY
1.222 + * @see #TACTICS_CURRENT_METHOD
1.223 + */
1.224 + public Vector getApplicableTactics(int scope) throws RemoteException;
1.225
1.226 - /**
1.227 - * @return Assumptions generated by the Tactic applied to the formula, both
1.228 - * under the same Iterator
1.229 - */
1.230 - public Assumptions getAssumptions() throws RemoteException;
1.231 + /**
1.232 + * @return Assumptions generated by the Tactic applied to the formula, both
1.233 + * under the same Iterator
1.234 + */
1.235 + public Assumptions getAssumptions() throws RemoteException;
1.236
1.237 - /**
1.238 - * @return Assumptions accumulated during calculation down to the formula
1.239 - * under the Iterator ATTENTION: this returnvalue is also used by
1.240 - * getAssumptions as long as getAccumulatedAssumptions does not
1.241 - * include references to their _several_ sources -- i.e. change
1.242 - * _this_ return, not that in getAssumptions !
1.243 - */
1.244 - public Assumptions getAccumulatedAssumptions() throws RemoteException;
1.245 + /**
1.246 + * @return Assumptions accumulated during calculation down to the formula
1.247 + * under the Iterator ATTENTION: this returnvalue is also used by
1.248 + * getAssumptions as long as getAccumulatedAssumptions does not
1.249 + * include references to their _several_ sources -- i.e. change
1.250 + * _this_ return, not that in getAssumptions !
1.251 + */
1.252 + public Assumptions getAccumulatedAssumptions() throws RemoteException;
1.253
1.254 - /**
1.255 - * The current level of nesting into subcalculations.
1.256 - *
1.257 - * @return An int representing level of nesting (higher == more detailed)
1.258 - * <p>
1.259 - * Special values:
1.260 - * <p>
1.261 - * 0: outmost level: only first and last step of calculation are on
1.262 - * this level
1.263 - */
1.264 - public int getLevel() throws RemoteException;
1.265 + /**
1.266 + * The current level of nesting into subcalculations.
1.267 + *
1.268 + * @return An int representing level of nesting (higher == more detailed)
1.269 + * <p>
1.270 + * Special values:
1.271 + * <p>
1.272 + * 0: outmost level: only first and last step of calculation are on
1.273 + * this level
1.274 + */
1.275 + public int getLevel() throws RemoteException;
1.276
1.277 - /**
1.278 - * Create a copy of this Iterator: the clone will point to the same formula
1.279 - * in the calcTree
1.280 - *
1.281 - * @return a cloned Iterator
1.282 - */
1.283 - public Object clone();
1.284 + /**
1.285 + * Create a copy of this Iterator: the clone will point to the same formula
1.286 + * in the calcTree
1.287 + *
1.288 + * @return a cloned Iterator
1.289 + */
1.290 + public Object clone();
1.291
1.292 - /**
1.293 - * for test-output
1.294 - *
1.295 - * @return 'position', i.e. unique identifier in a CalcTree
1.296 - */
1.297 - public String toSMLString();
1.298 + /**
1.299 + * for test-output
1.300 + *
1.301 + * @return 'position', i.e. unique identifier in a CalcTree
1.302 + */
1.303 + public String toSMLString();
1.304
1.305 - // /**
1.306 - // * Create a copy of this Iterator: the clone will point to the Position
1.307 - // * in the calcTree (Position may come from a formula in the worksheet)
1.308 - // *
1.309 - // * @return a cloned Iterator
1.310 - // */
1.311 - // public ICalcIterator clone(Position p);
1.312 + // /**
1.313 + // * Create a copy of this Iterator: the clone will point to the Position
1.314 + // * in the calcTree (Position may come from a formula in the worksheet)
1.315 + // *
1.316 + // * @return a cloned Iterator
1.317 + // */
1.318 + // public ICalcIterator clone(Position p);
1.319
1.320 - // /**
1.321 - // * @return the position unique within a calctree
1.322 - // * @see isac.uti.interfaces.ICalcIterator#clone(Position)
1.323 - // */
1.324 - // public Position getSmlPos();
1.325 + // /**
1.326 + // * @return the position unique within a calctree
1.327 + // * @see isac.uti.interfaces.ICalcIterator#clone(Position)
1.328 + // */
1.329 + // public Position getSmlPos();
1.330 }
1.331 \ No newline at end of file