Package org.cytoscape.work

This packages everything relating to tasks in Cytoscape.

See:
Description

Interface Summary

ServiceProperties	Reserved keywords for OSGi service properties (meta data).
SynchronousTaskManager<T>	A marker interface that indicates that the TaskManager in question will execute the tasks found in the TaskFactory synchronously, rather than asynchronously.
Task	This interface specifies a unit of work to be executed asynchronously in its own Thread along with a user interface to display its progress, provide a means for the user to cancel the Task, and show information about any Exceptions thrown during its execution.
TaskFactory	Returns an instance of a TaskIterator.
TaskManager<T,C>	Executes the Tasks found in the TaskIterator provided by a TaskFactory.
TaskMonitor	Used by Tasks to modify its user interface.
TunableHandler	Interface for classes that deal with reading out and writing back Tunables and their properties.
TunableHandlerFactory<T extends TunableHandler>	A factory service to create a TunableHandler for a single type of object, determined by the type of the field or the return value of the getter method in the appropriate methods.
TunableMutator<T extends TunableHandler,S>	This is a type of tunable interceptor that reads and modifies the values annotated with the Tunable annotation.
TunableRecorder<T extends TunableHandler>	TunableRecorder is a special type of tunable interceptor that reads the state of the tunables but does not modify the value of the tunables.
TunableSetter	An API for setting tunable fields and methods with predetermined values in the Tasks found in the specified TaskIterator.
TunableValidator	If implemented, this interface is used to apply a test to the modified values of a Tunable.

Class Summary

AbstractTask	A base class for tasks that need to be able to access the TaskIterator that contains them.
AbstractTaskFactory	A TaskFactory that is always ready to produce a TaskIterator.
AbstractTaskManager<T,C>	Provides access to a TunableInterceptor to all derived classes and a utility method to determine if an object has been annotated with Tunables.
AbstractTunableHandler	Provides the standard implementation for most of the methods declared by the TunableHandler interface.
AbstractTunableInterceptor<T extends TunableHandler>	An abstract base class for TunableRecorder and TunableMutator implementations.
BasicTunableHandlerFactory<T extends TunableHandler>	A convenience implementation of TunableHandlerFactory that will construct a TunableHandler of the specified type given the TunableHandler in question has at least two constructors, one with Field, Object, Tunable parameters and the other with Method, Method, Object, Tunable parameters.
TaskIterator	A TaskIterator provides the functionality of sequencing tasks.

Enum Summary

TunableValidator.ValidationState

This is what the TunableValidator can return.

Annotation Types Summary

ContainsTunables	An annotation designed to signal that the annotated field contains fields and methods that are annotated with the Tunable annotation.
ProvidesTitle	An annotation type that can be applied to a method which returns a String that will be used for the title of a Tunable user interface dialog window.
Tunable	An annotation type that can be applied to a field or a method in order to allow TunableInterceptor to catch it, and so to use its members to create a corresponding interface for a user.

Package org.cytoscape.work Description

This packages everything relating to tasks in Cytoscape. This includes Task, TaskFactory, TaskManager. and TaskIterator.