TaskGraphUtils

java.lang.Object
- org.trianacode.taskgraph.TaskGraphUtils

public class TaskGraphUtils
extends java.lang.Object

Utility functions useful in handling task graphs

Constructor Summary

Constructors
Constructor and Description

TaskGraphUtils()

Constructors
Constructor and Description
`TaskGraphUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Task`	`cloneTask(Task task, boolean preserveinst)` Creates a non-runnable clone of the specfied task, optionally preserving the instance id.
`static TaskGraph`	`cloneTaskGraph(TaskGraph taskgraph, java.lang.String factorytype)` Creates a full clone of the taskgraph, preserving the instances of the clone and all the tasks within the clone.
`static TaskGraph`	`cloneTaskGraph(TaskGraph taskgraph, TaskGraph parent, boolean preserveinst)` Creates a clone of the specified taskgraph within the parent, optionally preserving the instance ids of the cloned task.
`static Tool`	`cloneTool(Tool tool)` Creates a non-runnable clone of the specfied tool.
`static void`	`connectControlTask(TaskGraph taskgraph)` Sets up the connections for the loop task.
`static TaskGraph`	`copyTaskGraph(TaskGraph taskgraph, java.lang.String factorytype)` Creates a copy of the taskgraph, not preserving the instance id of the clone or the tasks within the clone.
`static Tool`	`createPlaceHolderTool(Tool tool)` Creates a place holder tool, which is a copy of only the nodes and tool classes of the specified tool.
`static Task[]`	`createTasks(Tool[] tools, TaskGraph taskgraph, boolean preserveinst)` Create new tasks in the specified taskgraph taskgraph, optionally preserving the original instance ids in the new tasks.
`static void`	`disconnectControlTask(TaskGraph taskgraph)` Removes the connections for the loop task.
`static void`	`disposeTool(Tool tool)` Disposes of the specified tool if no longer required
`static Task`	`dummyCloneTask(Task task, boolean preserveinst)` Creates a clone of the task.
`static Tool`	`dummyCloneTool(Tool tool)` Creates a clone of the tool.
`static java.lang.String[]`	`getAllDataInputTypes(Tool tool)`
`static java.lang.String[]`	`getAllDataOutputTypes(Tool tool)`
`static int`	`getAllTasksCount(TaskGraph taskGraph, boolean includecontrol)`
`static Task[]`	`getAllTasksRecursive(TaskGraph taskGraph, boolean includecontrol)`
`static void`	`getAllTasksRecursive(TaskGraph taskGraph, java.util.Vector copy, boolean includecontrol)` Recursively copy all the non-group tasks into the vector
`static Cable[]`	`getConnectedCables(Task task)`
`static Cable[]`	`getConnectedCables(Task[] tasklist)`
`static Task[]`	`getConnectedTasks(Task task)`
`static Cable[]`	`getExternalCables(Task[] tasklist)`
`static Task[]`	`getInputTasks(Task task)`
`static Cable[]`	`getInternalCables(Task[] tasklist)`
`static java.util.List<Task>`	`getLeafTasks(TaskGraph taskgraph)`
`static Task[]`	`getOutputTasks(Task task)`
`static java.util.List<Task>`	`getPredecessors(Task t)`
`static Task[]`	`getRemainingWorkflow(Task task, boolean include)`
`static java.util.List<Task>`	`getRootTasks(TaskGraph taskgraph)`
`static Node`	`getSourceNode(Node node)`
`static java.util.List<Task>`	`getSuccessors(Task t)`
`static boolean`	`isConnectedCable(Cable cable, Task task)`
`static boolean`	`isConnectedCable(Cable cable, Task[] tasklist)` Checks if a cable is connected to any task in an array of tasks
`static boolean`	`isControlTask(Task task)`
`static boolean`	`isExternalCable(Cable cable, Task[] tasklist)` Checks to see if a given cable is external to a set of tasks, i.e.
`static boolean`	`isInternalCable(Cable cable, Task[] tasklist)` Checks to see if a given cable is internal to a set of tasks, i.e.
`static Task`	`replaceTask(Task curtask, Tool newtool, boolean rename)` Replaces a current task with a new tool (instance id is preserved)
`static Task`	`replaceTask(Task curtask, Tool newtool, boolean rename, boolean preserveinst)` Replaces a current task with a new tool.
`static TaskGraph`	`semiCloneTaskGraph(TaskGraph taskgraph, java.lang.String factorytype)` Creates a semi-clone of the taskgraph, preserving the instances of the tasks within the the clone, but not the clone itself (i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaskGraphUtils
```
public TaskGraphUtils()
```
- Method Detail
  - isControlTask
```
public static boolean isControlTask(Task task)
```
    Returns:
    true if the specified task is a control task
  - cloneTool
```
public static Tool cloneTool(Tool tool)
                      throws TaskException
```
    Creates a non-runnable clone of the specfied tool.
    
    Throws:
    
    TaskException
  - cloneTask
```
public static Task cloneTask(Task task,
             boolean preserveinst)
                      throws TaskException
```
    Creates a non-runnable clone of the specfied task, optionally preserving the instance id.
    
    Throws:
    
    TaskException
  - dummyCloneTool
```
public static Tool dummyCloneTool(Tool tool)
                           throws TaskException
```
    Creates a clone of the tool. If the tool is a taskgraph then a dummy single tool is returned
    
    Throws:
    
    TaskException
  - dummyCloneTask
```
public static Task dummyCloneTask(Task task,
                  boolean preserveinst)
                           throws TaskException
```
    Creates a clone of the task. If the task is a taskgraph then a dummy single task is returned
    
    Throws:
    
    TaskException
  - createPlaceHolderTool
```
public static Tool createPlaceHolderTool(Tool tool)
                                  throws TaskException
```
    Creates a place holder tool, which is a copy of only the nodes and tool classes of the specified tool.
    
    Throws:
    
    TaskException
  - cloneTaskGraph
```
public static TaskGraph cloneTaskGraph(TaskGraph taskgraph,
                       TaskGraph parent,
                       boolean preserveinst)
                                throws TaskGraphException
```
    Creates a clone of the specified taskgraph within the parent, optionally preserving the instance ids of the cloned task.
    
    Throws:
    
    TaskGraphException
  - cloneTaskGraph
```
public static TaskGraph cloneTaskGraph(TaskGraph taskgraph,
                       java.lang.String factorytype)
                                throws TaskGraphException
```
    Creates a full clone of the taskgraph, preserving the instances of the clone and all the tasks within the clone. Note that setParent() and init() are not called on the clone.
    
    Throws:
    
    TaskGraphException
  - semiCloneTaskGraph
```
public static TaskGraph semiCloneTaskGraph(TaskGraph taskgraph,
                           java.lang.String factorytype)
                                    throws TaskGraphException
```
    Creates a semi-clone of the taskgraph, preserving the instances of the tasks within the the clone, but not the clone itself (i.e. the clone is a new taskgraph instance with the same contents). Note that the control task is not cloned. Also note that setParent() and init() are not called on the clone.
    
    Throws:
    
    TaskGraphException
  - copyTaskGraph
```
public static TaskGraph copyTaskGraph(TaskGraph taskgraph,
                      java.lang.String factorytype)
                               throws TaskGraphException
```
    Creates a copy of the taskgraph, not preserving the instance id of the clone or the tasks within the clone. Note that setParent() and init() are not called on the clone.
    
    Throws:
    
    TaskGraphException
  - createTasks
```
public static Task[] createTasks(Tool[] tools,
                 TaskGraph taskgraph,
                 boolean preserveinst)
                          throws TaskException,
                                 CableException
```
    Create new tasks in the specified taskgraph taskgraph, optionally preserving the original instance ids in the new tasks. Any connections between the specified tools are also created.
    
    Returns:
    the interfaces to the new tasks
    
    Throws:
    
    TaskException
    
    CableException
  - replaceTask
```
public static Task replaceTask(Task curtask,
               Tool newtool,
               boolean rename)
                        throws TaskGraphException
```
    Replaces a current task with a new tool (instance id is preserved)
    
    Throws:
    
    TaskGraphException
  - replaceTask
```
public static Task replaceTask(Task curtask,
               Tool newtool,
               boolean rename,
               boolean preserveinst)
                        throws TaskGraphException
```
    Replaces a current task with a new tool.
    Note that newtool is a task with no parent it is automatically disposed after the replacement task has been created.
    
    Parameters:
    curtask - the task being replaced
    newtool - the tool used to replace the existing task
    rename - true if the new task should take the same name as the existing task
    preserveinst - true if the new task should preseve the instance id of newtool
    
    Throws:
    
    TaskGraphException
  - disposeTool
```
public static void disposeTool(Tool tool)
```
    Disposes of the specified tool if no longer required
  - getConnectedCables
```
public static Cable[] getConnectedCables(Task task)
```
    Returns:
    an array of the cables connected to the specified task
  - getConnectedCables
```
public static Cable[] getConnectedCables(Task[] tasklist)
```
    Returns:
    an array of the cables connected to the specified tasks (internal and external)
  - isConnectedCable
```
public static boolean isConnectedCable(Cable cable,
                       Task task)
```
    Returns:
    true if a given cable is connected to a given task
  - isConnectedCable
```
public static boolean isConnectedCable(Cable cable,
                       Task[] tasklist)
```
    Checks if a cable is connected to any task in an array of tasks
  - getInternalCables
```
public static Cable[] getInternalCables(Task[] tasklist)
```
    Returns:
    the set of cables that are internal to a given set of tasks, i.e. only cables that connect two tasks in the input set.
  - isInternalCable
```
public static boolean isInternalCable(Cable cable,
                      Task[] tasklist)
```
    Checks to see if a given cable is internal to a set of tasks, i.e. it connects two of the given tasks.
  - getExternalCables
```
public static Cable[] getExternalCables(Task[] tasklist)
```
    Returns:
    the set of cables that are external to a given set of tasks, i.e. only cables that connect a task in the input set with one outside.
  - isExternalCable
```
public static boolean isExternalCable(Cable cable,
                      Task[] tasklist)
```
    Checks to see if a given cable is external to a set of tasks, i.e. it connects a task in the input set with one outside.
  - getInputTasks
```
public static Task[] getInputTasks(Task task)
```
    Returns:
    all the tasks that preceed the specified task
  - getOutputTasks
```
public static Task[] getOutputTasks(Task task)
```
    Returns:
    all the tasks that follow the specified task
  - getConnectedTasks
```
public static Task[] getConnectedTasks(Task task)
```
    Returns:
    all the tasks that are connected to the specified task
  - getRemainingWorkflow
```
public static Task[] getRemainingWorkflow(Task task,
                          boolean include)
```
    Returns:
    the remaining workflow that follows the specified task, optionally including the original task at index 0.
  - connectControlTask
```
public static void connectControlTask(TaskGraph taskgraph)
                               throws TaskGraphException
```
    Sets up the connections for the loop task. Input/output from the group now goes via the loop task.
    
    Throws:
    
    TaskGraphException
  - disconnectControlTask
```
public static void disconnectControlTask(TaskGraph taskgraph)
                                  throws TaskGraphException
```
    Removes the connections for the loop task.
    
    Throws:
    
    TaskGraphException
  - getSourceNode
```
public static Node getSourceNode(Node node)
```
    Returns:
    the ultimate source node that sends data to/receives data from the given node (ignoring control tasks). Null if not connected.
  - getAllTasksCount
```
public static int getAllTasksCount(TaskGraph taskGraph,
                   boolean includecontrol)
```
    Returns:
    a count of all the tasks within a taskgraph and its sub taskgraphs (optionally including control tasks)
  - getAllTasksRecursive
```
public static Task[] getAllTasksRecursive(TaskGraph taskGraph,
                          boolean includecontrol)
```
    Returns:
    an array of all tasks within a taskgraph and its sub taskgraphs, optionally including control tasks
  - getAllTasksRecursive
```
public static void getAllTasksRecursive(TaskGraph taskGraph,
                        java.util.Vector copy,
                        boolean includecontrol)
```
    Recursively copy all the non-group tasks into the vector
  - getAllDataInputTypes
```
public static java.lang.String[] getAllDataInputTypes(Tool tool)
```
    Returns:
    all the data types input by the nodes on the specified tool.
  - getAllDataOutputTypes
```
public static java.lang.String[] getAllDataOutputTypes(Tool tool)
```
    Returns:
    all the data types input by the nodes on the specified tool.
  - getSuccessors
```
public static java.util.List<Task> getSuccessors(Task t)
```
  - getPredecessors
```
public static java.util.List<Task> getPredecessors(Task t)
```
  - getLeafTasks
```
public static java.util.List<Task> getLeafTasks(TaskGraph taskgraph)
```
  - getRootTasks
```
public static java.util.List<Task> getRootTasks(TaskGraph taskgraph)
```

Class TaskGraphUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaskGraphUtils

Method Detail

isControlTask

cloneTool

cloneTask

dummyCloneTool

dummyCloneTask

createPlaceHolderTool

cloneTaskGraph

cloneTaskGraph

semiCloneTaskGraph

copyTaskGraph

createTasks

replaceTask

replaceTask

disposeTool

getConnectedCables

getConnectedCables

isConnectedCable

isConnectedCable

getInternalCables

isInternalCable

getExternalCables

isExternalCable

getInputTasks

getOutputTasks

getConnectedTasks

getRemainingWorkflow

connectControlTask

disconnectControlTask

getSourceNode

getAllTasksCount

getAllTasksRecursive

getAllTasksRecursive

getAllDataInputTypes

getAllDataOutputTypes

getSuccessors

getPredecessors

getLeafTasks

getRootTasks