flux
Interface CatalogNode

public interface CatalogNode

Represents a trigger or action within the tree of actions. These actions are used to construct flow charts.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.beans.BeanInfo	getBeanInfo() Returns property information for an action.
java.util.SortedSet	getChildren() Returns all the child nodes of this node.
java.lang.String	getName() Returns the fully qualified name of the current position in the tree.
Action	makeAction(FlowChart flowChart) Creates an action from the specified flow chart that corresponds to this ActionNode.
Action	makeAction(FlowChart flowChart, java.lang.String actionName) Creates an action from the specified flow chart that corresponds to this ActionNode.

Method Detail

getBeanInfo

java.beans.BeanInfo getBeanInfo()

Returns property information for an action. The property information contains the fully qualified name of the action and information on each of the action's properties.

Returns:

Property information for an action. Returns null if this node represents a factory. At a minimum, the root of the tree of actions represents a factory, flux.FlowChart.

getChildren

java.util.SortedSet getChildren()

Returns all the child nodes of this node. The nodes are sorted by name.

Returns:

SortedSet of CatalogNode. Returns all the child nodes of this node. Returns null if there are no children.

getName

java.lang.String getName()

Returns the fully qualified name of the current position in the tree. Levels in the tree are separated by "/" symbols.

Returns:

The name of the current position in the tree.

See Also:

EngineHelper.getNameComponents(java.lang.String)

makeAction

Action makeAction(FlowChart flowChart)

Creates an action from the specified flow chart that corresponds to this ActionNode. Delegates to an appropriate action factory method on the FlowChart interface or a descendent factory interface off FlowChart.

Parameters:

flowChart - The flow chart on which the new action is made.

Returns:

An action from the specified flow chart that corresponds to this ActionNode. The action has an arbitrary, but non-null and non-empty, name.

Throws:

java.lang.IllegalArgumentException - If the specified flow chart is null.

makeAction

Action makeAction(FlowChart flowChart,
                  java.lang.String actionName)

Creates an action from the specified flow chart that corresponds to this ActionNode. Delegates to an appropriate action factory method on the FlowChart interface or a descendent factory interface off FlowChart.

Parameters:

flowChart - The flow chart on which the new action is made.

actionName - The name of the returned action.

Returns:

An action from the specified flow chart that corresponds to this ActionNode. The action's name is set to actionName.

Throws:

java.lang.IllegalArgumentException - If the specified flow chart is null.