org.apache.oozie.fluentjob.api.dag

Class NodeBase

java.lang.Object

org.apache.oozie.fluentjob.api.dag.NodeBase

Direct Known Subclasses:

Decision, End, ExplicitNode, Fork, JoiningNodeBase, Start

public abstract class NodeBase
extends Object

An abstract base class for nodes in the intermediate graph representation of the workflow. Nodes in this graph may contain information about nodes of the API level graph (ExplicitNode) or be generated control nodes (for example Fork).

These nodes should not be used directly by the end user.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeBase(String name) Creates a new NodeBase object with the given name.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addChild(NodeBase child) Adds a child to this NodeBase object.
abstract void	addParent(NodeBase parent) Adds the provided node as a parent of this NodeBase object.
abstract void	addParentDefaultConditional(Decision parent) Adds the provided node as the default conditional parent of this NodeBase object.
abstract void	addParentWithCondition(Decision parent, Condition condition) Adds the provided node as a conditional parent of this NodeBase object.
abstract void	clearParents() Removes all parents (whether or not conditional) of this NodeBase object.
abstract List<NodeBase>	getChildren() Returns all the children (whether conditional or not) of this NodeBase object.
String	getName() Returns the name of this NodeBase object.
protected abstract void	removeChild(NodeBase child) Removes the specified child from this NodeBase object.
abstract void	removeParent(NodeBase parent) Removes a parent (whether or not conditional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeBase

protected NodeBase(String name)

Creates a new NodeBase object with the given name.

Parameters:

name - The name of the new NodeBase object.

Method Detail

getName

public String getName()

Returns the name of this NodeBase object.

Returns:

The name of this NodeBase object.

addParent

public abstract void addParent(NodeBase parent)

Adds the provided node as a parent of this NodeBase object.

Parameters:

parent - The new parent of this NodeBase object.

addParentWithCondition

public abstract void addParentWithCondition(Decision parent,
                                            Condition condition)

Adds the provided node as a conditional parent of this NodeBase object.

Parameters:

parent - The new conditional parent of this NodeBase object.

condition - The condition which must be true in addition the parent completing successfully for this node to be executed.

addParentDefaultConditional

public abstract void addParentDefaultConditional(Decision parent)

Adds the provided node as the default conditional parent of this NodeBase object.

Parameters:

parent - The new conditional parent of this NodeBase object.

removeParent

public abstract void removeParent(NodeBase parent)

Removes a parent (whether or not conditional).

Parameters:

parent - The parent to remove.

Throws:

IllegalStateException - if parent is not the parent of this node.

clearParents

public abstract void clearParents()

Removes all parents (whether or not conditional) of this NodeBase object.

getChildren

public abstract List<NodeBase> getChildren()

Returns all the children (whether conditional or not) of this NodeBase object.

Returns:

All the children (whether conditional or not) of this NodeBase object.

addChild

protected abstract void addChild(NodeBase child)

Adds a child to this NodeBase object. This method should only be used in the implementation of the addParent(NodeBase) method of a subclass of NodeBase, so that whenever a node is assigned a new parent, the parent also knows about the child.

Parameters:

child - The node to be added as the child of this NodeBase.

removeChild

protected abstract void removeChild(NodeBase child)

Removes the specified child from this NodeBase object. This method should only be used in the implementation of the removeParent(NodeBase) method of a subclass of NodeBase, so that whenever a child is removed from a node, the parent also knows about the child having been removed.

Parameters:

child - The node to be removed as the child of this NodeBase.