FlowTreeNode

import data.tree.*;
import org.asapframework.util.StringUtilsSplit;

/**
FlowTreeNode is an instruction storage class used by {@link FlowController}.
This is a typical instruction line:
<code>
question2, label=This is question 2, text="Was Mick Jagger the lead singer of the Beatles?", type=condition, yes=trunk1end, no=screen5
</code>
FlowTreeNode lists a number of reserved instruction attributes:
<ul>
    <li>{@link #type}</li>
    <li>{@link #label}</li>
    <li>{@link #text}</li>
    <li>{@link #method}</li>
    <li>{@link #await}</li>
    <li>{@link #timeout}</li>
    <li>{@link #parameters}</li>
</ul>
Other attributes can be used, with arbitrary names. For instance, you might want to use the attributes {@code wrong} and {@code right}:
<code>
question2, label=This is question 2, text="Was Mick Jagger the lead singer of the Beatles?", type=condition, wrong=trunk1end, right=screen5
</code>
The attribute values of these names can be retrieved with  {@link TreeNode#getValueForKey}.
@author Arthur Clemens
@version 20 July 2005
*/

class data.tree.FlowTreeNode extends TreeNode {

    private var mParameters:Array;
    private var mConditions:Array;
    private static var DELIMITER:String = ",";
    
    /**
    Creates a new FlowTreeNode.
    */
    function FlowTreeNode (inName:String,
                           inProperties:Object)
    {
        super(inName, inProperties);
    }
    
    /**
    The node's type attribute. Possible types:
    <ul>
        <li>condition</li>
        <li>action</li>
        <li>await</li>
        <li>exit</li>
    </ul>
    See {@link FlowController#run} to see how FlowController deals with these types.
    */
    public function get type () : String
    {
        return mProperties.type;
    }
    
    /**
    The node's label attribute.
    */
    public function get label () : String
    {
        return mProperties.label;
    }
    
    /**
    The node's text attribute.
    */
    public function get text () : String
    {
        return mProperties.text;
    }
    
    /**
    The node's method attribute.
    */
    public function get method () : String
    {
        return mProperties.method;
    }

    /**
    The node's await attribute.
    */
    public function get await () : String
    {
        return mProperties.await;
    }
    
    /**
    The node's timeout attribute.
    */
    public function get timeout () : String
    {
        return mProperties.timeout;
    }

    /**
    The node's method parameters attribute.
    */
    public function get parameters () : Array
    {
        if (mParameters == undefined) {
            mParameters = StringUtilsSplit.splitSpecial(mProperties.parameters, FlowTreeNode.DELIMITER);
        }
        return mParameters;
    }
    
    /**
    The node's evaluate conditions attribute.
    */
    public function get conditions () : Array
    {
        if (mConditions == undefined) {
            mConditions = StringUtilsSplit.splitSpecial(mProperties.conditions, FlowTreeNode.DELIMITER);
        }
        return mConditions;
    }

    /**
    @exclude
    */
    public function toString () : String
    {
        return "(FlowTreeNode) name=" + mName + "; depth=" + mDepth + "; parent name=" + mParent.name + "; child count=" + mChildren.length + "; owner=" + mOwner + "\n\t type=" + type + "\n\t label=" + label + "\n\t text=" + text + "\n\t parameters=" + parameters + "\n\t conditions=" + conditions;
    }
    
    // PRIVATE METHODS

    /**
    This method must be implemented by all subclasses of {@link TreeNode}.
    */
    private function createNewNode (inName:String, inProperties:Object) : FlowTreeNode
    {
        return new FlowTreeNode(inName, inProperties);
    }
    
}