org.jicengine.element
Class ElementImpl.ActionElementImpl

java.lang.Object
  extended byorg.jicengine.element.ElementImpl.ActionElementImpl
All Implemented Interfaces:
ActionElement, Element
Enclosing class:
ElementImpl

public class ElementImpl.ActionElementImpl
extends java.lang.Object
implements ActionElement

ActionElement-version of an ElementImpl.

Author:
timo

Field Summary
 
Fields inherited from interface org.jicengine.element.Element
VARIABLE_NAME_CDATA, VARIABLE_NAME_ELEMENT_INSTANCE, VARIABLE_NAME_PARENT_INSTANCE
 
Constructor Summary
ElementImpl.ActionElementImpl()
           
 
Method Summary
 void execute(Context globalContext, java.lang.Object parentInstance)
           Executes the action of this element.
 java.lang.String getName()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ElementImpl.ActionElementImpl

public ElementImpl.ActionElementImpl()
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface Element

execute

public void execute(Context globalContext,
                    java.lang.Object parentInstance)
             throws ElementException
Description copied from interface: ActionElement

Executes the action of this element. The operation doesn't return any value to its caller, although it can internally produce a value.

The client/user of this element will call this method. currently, the method is called only once. However, the action should be able to be executed multiple times.

in general, the execution consists of the following steps:

  1. if the element has an instance, it is created first (with parameters)
  2. if the element has other ActionElements as children, they are executed next
  3. finally, the actual action is executed (with parameters)

Specified by:
execute in interface ActionElement
Parameters:
globalContext - a Context where the instances marked with the 'id'-attribute are put.
parentInstance - the instance of the parent element. NOTE: null-value means that the value of the parent is not available (not yet or never), not that the instance of the parent is null!
Throws:
ElementException - if any part of the execution of the action fails.