public interface CyJobData
CyJobData presents a general interface to sending data to and receiving data from a job. The api is meant to be very similar to that of a
String keys and arbirary
as values. Note that no type checking is done -- the values might
Lists or a variety of
other objects (notably Cytoscape model and view model objects). The
detailed implementation for this object is managed by a
which should be able to use the information contains within the object to
create the appropriate data structure to send to a remote job
() and retrieve the
information from the remote job ().
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.
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>jobs-api</artifactId> </dependency>
Method SummaryModifier and TypeMethodDescription
clear()Clear all of the data
booleanTest to see if a key exists in the current CyJobData.Returns the Object that contains the value for the specified key, or null if that key doesn't exist.Return all of the values in this CyJobData
keySet()Return the enumerated set of keys in this CyJobData.
voidSet the value for a particular key.Remove the data for a key
getReturns the Object that contains the value for the specified key, or null if that key doesn't exist.
key- the key to access the requested data
- the data, if that key exists or null
keySetReturn the enumerated set of keys in this CyJobData.
- the set of keys
(String key)Test to see if a key exists in the current CyJobData.
key- the key to test
- true if that key exists, false otherwise
getAllValuesReturn all of the values in this CyJobData
Mapof all of the data in this CyJobData object.
putSet the value for a particular key.
key- the key to set the value for
value- the value to set
removeRemove the data for a key
key- the key to remove the data for
- the removed object or null if the key doesn't exit
clearvoid clear()Clear all of the data