Class Evaluation

java.lang.Object
ognl.Evaluation
public class Evaluation extends Object
An Evaluation is and object that holds a node being evaluated and the source from which that node will take extract its value. It refers to child evaluations that occur as a result of the nodes' evaluation.

  • Field Details

  • Constructor Details

    • Evaluation

      public Evaluation(SimpleNode node, Object source)
      Constructs a new "get" Evaluation from the node and source given.
      Parameters:
      node - a SimpleNode for this Evaluation.
      source - a source Object for this Evaluation.

    • Evaluation

      public Evaluation(SimpleNode node, Object source, boolean setOperation)
      Constructs a new Evaluation from the node and source given. If setOperation is true this Evaluation represents a "set" as opposed to a "get".
      Parameters:
      node - a SimpleNode for this Evaluation.
      source - a source Object for this Evaluation.
      setOperation - true to identify this Evaluation as a set operation, false to identify it as a get operation.

  • Method Details

    • getNode

      public SimpleNode getNode()
      Returns the SimpleNode for this Evaluation
      Returns:
      the SimpleNode for this Evaluation.

    • setNode

      public void setNode(SimpleNode value)
      Sets the node of the evaluation. Normally applications do not need to set this. Notable exceptions to this rule are custom evaluators that choose between navigable objects (as in a multi-root evaluator where the navigable node is chosen at runtime).
      Parameters:
      value - the SimpleNode to set for this Evaluation.

    • getSource

      public Object getSource()
      Returns the source object on which this Evaluation operated.
      Returns:
      the source Object operated upon by this Evaluation.

    • setSource

      public void setSource(Object value)
      Sets the source of the evaluation. Normally applications do not need to set this. Notable exceptions to this rule are custom evaluators that choose between navigable objects (as in a multi-root evaluator where the navigable node is chosen at runtime).
      Parameters:
      value - the source Object to be set for this Evaluation.

    • isSetOperation

      public boolean isSetOperation()
      Returns true if this Evaluation represents a set operation.
      Returns:
      true if this Evaluation represents a set operation, false otherwise.

    • setSetOperation

      public void setSetOperation(boolean value)
      Marks the Evaluation as a set operation if the value is true, else marks it as a get operation.
      Parameters:
      value - true to identify this Evaluation as a set operation, false to identify it as a get operation.

    • getResult

      public Object getResult()
      Returns the result of the Evaluation, or null if it was a set operation.
      Returns:
      the result of the Evaluation (for a get operation), or null (for a set operation).

    • setResult

      public void setResult(Object value)
      Sets the result of the Evaluation. This method is normally only used interally and should not be set without knowledge of what you are doing.
      Parameters:
      value - the result Object for this Evaluation.

    • getException

      public Throwable getException()
      Returns the exception that occurred as a result of evaluating the Evaluation, or null if no exception occurred.
      Returns:
      an exception if one occurred during evaluation, or null (no exception) otherwise.

    • setException

      public void setException(Throwable value)
      Sets the exception that occurred as a result of evaluating the Evaluation. This method is normally only used interally and should not be set without knowledge of what you are doing.
      Parameters:
      value - the Throwable exception that occurred during the evaluation of this Evaluation.

    • getParent

      public Evaluation getParent()
      Returns the parent evaluation of this evaluation. If this returns null then it is is the root evaluation of a tree.
      Returns:
      the parent Evaluation of the current Evaluation, or null if no parent exists.

    • getNext

      public Evaluation getNext()
      Returns the next sibling of this evaluation. Returns null if this is the last in a chain of evaluations.
      Returns:
      the next sibling Evaluation of the current Evaluation, or null if this is the last Evaluation in a chain.

    • getPrevious

      public Evaluation getPrevious()
      Returns the previous sibling of this evaluation. Returns null if this is the first in a chain of evaluations.
      Returns:
      the previous sibling Evaluation of the current Evaluation, or null if this is the first Evaluation in a chain.

    • getFirstChild

      public Evaluation getFirstChild()
      Returns the first child of this evaluation. Returns null if there are no children.
      Returns:
      the first child Evaluation of the current Evaluation, or null if no children exist.

    • getLastChild

      public Evaluation getLastChild()
      Returns the last child of this evaluation. Returns null if there are no children.
      Returns:
      the last child Evaluation of the current Evaluation, or null if no children exist.

    • getFirstDescendant

      public Evaluation getFirstDescendant()
      Gets the first descendent. In any Evaluation tree this will the Evaluation that was first executed.
      Returns:
      the first descendant Evaluation (first Evaluation executed in the tree).

    • getLastDescendant

      public Evaluation getLastDescendant()
      Gets the last descendent. In any Evaluation tree this will the Evaluation that was most recently executing.
      Returns:
      the last descendant Evaluation (most recent Evaluation executed in the tree).

    • addChild

      public void addChild(Evaluation child)
      Adds a child to the list of children of this evaluation. The parent of the child is set to the receiver and the children references are modified in the receiver to reflect the new child. The lastChild of the receiver is set to the child, and the firstChild is set also if child is the first (or only) child.
      Parameters:
      child - an Evaluation to add as a child to the current Evaluation.

    • init

      public void init(SimpleNode node, Object source, boolean setOperation)
      Reinitializes this Evaluation to the parameters specified.
      Parameters:
      node - a SimpleNode for this Evaluation.
      source - a source Object for this Evaluation.
      setOperation - true to identify this Evaluation as a set operation, false to identify it as a get operation.

    • reset

      public void reset()
      Resets this Evaluation to the initial state.

    • toString

      public String toString(boolean compact, boolean showChildren, String depth)
      Produces a String value for the Evaluation. If compact is true then a more compact form of the description only including the node type and unique identifier is shown, else a full description including source and result are shown. If showChildren is true the child evaluations are printed using the depth string given as a prefix.
      Parameters:
      compact - true to generate a compact form of the description for this Evaluation, false for a full form.
      showChildren - true to generate descriptions for child Evaluation elements of this Evaluation.
      depth - prefix String to use in front of child Evaluation description output - used when showChildren is true.
      Returns:
      the description of this Evaluation as a String.

    • toString

      public String toString(boolean compact, String depth)
      Produces a String value for the Evaluation. If compact is true then a more compact form of the description only including the node type and unique identifier is shown, else a full description including source and result are shown. Child evaluations are printed using the depth string given as a prefix.
      Parameters:
      compact - true to generate a compact form of the description for this Evaluation, false for a full form.
      depth - prefix String to use in front of child Evaluation description output - used when showChildren is true.
      Returns:
      the description of this Evaluation as a String.

    • toString

      public String toString()
      Returns a String description of the Evaluation.
      Overrides:
      toString in class Object
      Returns:
      the description of this Evaluation as a String.