net.sourceforge.jobman

Class Node

java.lang.Object

net.sourceforge.jobman.Task

net.sourceforge.jobman.Node

Direct Known Subclasses:

BasicNode, CaseNode, DepNode, ParNode

abstract class Node
extends Task

This class represent a job with child jobs. It can be a job of type loop, fork, plop, pfrk.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Task>	activeChildren The vector of active children, those child jobs to be run or being run.
private boolean	inParallel Specify if child tasks will be processed in parallel.
private boolean	prepared If the preliminary jobs have been completed, this is true.
protected java.util.LinkedList<java.lang.String[]>	unconstructed List of child jobs not constructed yet.

Fields inherited from class net.sourceforge.jobman.Task

name, nameParSep, param, parent

Constructor Summary

Constructors

Constructor and Description
Node(Node parent, java.lang.String name, java.lang.String param, boolean inParallel, boolean prepared)

Method Summary

Modifier and Type	Method and Description
protected Status	advance() Check the current status assuming the last update had status RUNNING.
private void	branch()
private Status	doBreak()
protected java.lang.String	dumpMore()
protected java.lang.String	dumpMoreFurther()
protected boolean	isParameterized()
protected boolean	postPrep() Precess the results of preparation jobs after all its current active children are finished.
protected void	postSuccess()
protected abstract void	prePrep() Initial setup of the child jobs.
protected void	terminate() Terminate this job.

Methods inherited from class net.sourceforge.jobman.Task

debugDump, extractTaskName, fetchAncestry, getLevel, getName, getParam, getStatus, hasSucceededLast, ignore, kill, markFail, toString, updateStatus

Methods inherited from class java.lang.Object

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

Field Detail

inParallel

private final boolean inParallel

Specify if child tasks will be processed in parallel. Once a Node is formed, this member is fixed and not subject to dynamic changes.

prepared

private boolean prepared

If the preliminary jobs have been completed, this is true.

activeChildren

private final java.util.List<Task> activeChildren

The vector of active children, those child jobs to be run or being run. This vector changes with status of this Task.

unconstructed

protected final java.util.LinkedList<java.lang.String[]> unconstructed

List of child jobs not constructed yet. It maps job name to the new job parameter.

Constructor Detail

Node

Node(Node parent,
     java.lang.String name,
     java.lang.String param,
     boolean inParallel,
     boolean prepared)
throws java.lang.Exception

Parameters:

parent - The parent job.

name - The name of the job.

inParallel - If true, the child jobs of this Node will run in parallel. Otherwise, they will run in sequence. For non-parameterized jobs, this is always true. For parameterized jobs, this indicate if all parameters to the jobs are set up.

Throws:

java.lang.Exception

Method Detail

branch

private void branch()
             throws java.lang.Exception

Throws:

java.lang.Exception

advance

protected final Status advance()
                        throws java.lang.Exception

Description copied from class: Task

Check the current status assuming the last update had status RUNNING.

Specified by:

advance in class Task

Returns:

true if the current job has finished.

Throws:

java.lang.Exception

doBreak

private Status doBreak()

terminate

protected void terminate()

Terminate this job. This Node job will in turn try to kill it child jobs.

Specified by:

terminate in class Task

prePrep

protected abstract void prePrep()

Initial setup of the child jobs.

postPrep

protected boolean postPrep()
                    throws java.lang.Exception

Precess the results of preparation jobs after all its current active children are finished.

Returns:

true if post preparation actions are performed successfully. This means the main jobs in the second stage can be performed.

Throws:

java.lang.Exception

postSuccess

protected void postSuccess()

dumpMoreFurther

protected java.lang.String dumpMoreFurther()

dumpMore

protected java.lang.String dumpMore()

Specified by:

dumpMore in class Task

isParameterized

protected boolean isParameterized()