org.cytoscape.command

Interface CommandExecutorTaskFactory

public interface CommandExecutorTaskFactory

TODO: Missing documentation

Module: command-executor-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>command-executor-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(File commandFile, TaskObserver observer) Creates a task iterator that will execute the specified commands.
TaskIterator	createTaskIterator(List<String> commands, TaskObserver observer) Creates a task iterator that will execute the specified commands.
TaskIterator	createTaskIterator(String namespace, String command, Map<String,Object> args, TaskObserver observer) Creates a task iterator that will execute the specified command.
TaskIterator	createTaskIterator(TaskObserver observer, String... commands) Creates a task iterator that will execute the specified commands.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(File commandFile,
                                TaskObserver observer)

Creates a task iterator that will execute the specified commands.

Parameters:

commandFile - A file containing a one command string per line, blank lines, or comment lines beginning with the '#' character.

observer - a possible observer for this series of tasks

Returns:

A task iterator that will execute the specified commands.

createTaskIterator

TaskIterator createTaskIterator(TaskObserver observer,
                                String... commands)

Creates a task iterator that will execute the specified commands.

Parameters:

observer - a possible observer for this series of tasks

commands - One or more strings where each string represents one command to execute.

Returns:

A task iterator that will execute the specified commands.

createTaskIterator

TaskIterator createTaskIterator(List<String> commands,
                                TaskObserver observer)

Creates a task iterator that will execute the specified commands.

Parameters:

commands - One or more strings where each string represents one command to execute.

observer - a possible observer for this series of tasks

Returns:

A task iterator that will execute the specified commands.

createTaskIterator

TaskIterator createTaskIterator(String namespace,
                                String command,
                                Map<String,Object> args,
                                TaskObserver observer)

Creates a task iterator that will execute the specified command. Note that this differs from the other methods in that this assumes the command string has already been parsed

Parameters:

namespace - the command namespace

command - the command

args - the map of arguments

observer - a possible observer for this series of tasks

Returns:

A task iterator that will execute the specified commands.