DTRules/src/main/java/com/dtrules/decisiontables/DTNode.java

   1 /*
   2  * $Id$
   3  *
   4  * Copyright 2004-2007 MTBJ, Inc.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 package com.dtrules.decisiontables;
  20
  21 import com.dtrules.infrastructure.RulesException;
  22 import com.dtrules.session.DTState;
  23
  24 public interface DTNode {
  25    static class Coordinate {
  26        int row;
  27        int col;
  28        Coordinate(int row, int col){
  29            this.row = row;
  30            this.col = col;
  31        }
  32     public int getCol() {
  33         return col;
  34     }
  35     public void setCol(int col) {
  36         this.col = col;
  37     }
  38     public int getRow() {
  39         return row;
  40     }
  41     public void setRow(int row) {
  42         this.row = row;
  43     }
  44    }
  45
  46    public int getRow();
  47
  48    /**
  49     * Returns a clone of this node, and all nodes below (if it
  50     * has subnodes).
  51     * @return
  52     */
  53    public DTNode cloneDTNode();
  54
  55    public int countColumns();
  56
  57    void       execute(DTState state) throws RulesException;
  58    Coordinate validate();
  59
  60    /**
  61     * For two DTNodes are equal if every path through both nodes
  62     * execute exactly the same set of Actions.
  63     * @param node
  64     * @return
  65     */
  66    boolean    equalsNode(DTNode node);
  67    /**
  68     * Returns an ANode which represents the execution of every
  69     * path through the given DTNode.  If different paths through
  70     * the DTNode execute different actions, this method returns
  71     * a null.  Note that ANodes always return themselves (i.e.
  72     * there is only one execution path through an ANode).
  73     */
  74    ANode      getCommonANode();
  75 }