Cytoscape 3.0.1 API

org.cytoscape.task
Interface TableTaskFactory

All Known Subinterfaces:
DeleteTableTaskFactory, ExportTableTaskFactory, JoinTablesTaskTaskFactory, MapGlobalToLocalTableTaskFactory, MapTableToNetworkTablesTaskFactory
All Known Implementing Classes:
AbstractTableTaskFactory

public interface TableTaskFactory

A task factory that creates one or more tasks that operate on the specified CyTable.


Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary
 TaskIterator createTaskIterator(CyTable table)
          Used to provision this factory with a CyTable that will be used to create tasks.
 boolean isReady(CyTable table)
          Returns true if this task factory is ready to produce a TaskIterator.
 

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyTable table)
Used to provision this factory with a CyTable that will be used to create tasks.

Parameters:
table - a non-null CyTable
Returns:
A TaskIterator object containing one or more Task objects to execute.

isReady

boolean isReady(CyTable table)
Returns true if this task factory is ready to produce a TaskIterator.

Parameters:
table - a non-null CyTable
Returns:
true if this task factory is ready to produce a TaskIterator.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.